Поделиться через


<para> (Visual Basic)

Указывает, что содержимое отформатировано как абзац.

<para>content</para>

Параметры

  • content
    Текст абзаца.

Заметки

Тег <para> предназначен для использования внутри тега, такого как <summary> (Visual Basic), <remarks> (Visual Basic) или <returns> (Visual Basic) и позволяет добавлять структуру в текст.

Чтобы выделить документирующие комментарии в отдельный файл, необходимо использовать при компиляции параметр /doc.

Пример

В этом примере тег <para> используется для разбиения области примечаний для метода UpdateRecord на два абзаца.

''' <param name="id">The ID of the record to update.</param> 
''' <remarks>Updates the record <paramref name="id"/>. 
''' <para>Use <see cref="DoesRecordExist"/> to verify that 
''' the record exists before calling this method.</para> 
''' </remarks> 
Public Sub UpdateRecord(ByVal id As Integer)
    ' Code goes here. 
End Sub 
''' <param name="id">The ID of the record to check.</param> 
''' <returns><c>True</c> if <paramref name="id"/> exists, 
''' <c>False</c> otherwise.</returns> 
''' <remarks><seealso cref="UpdateRecord"/></remarks> 
Public Function DoesRecordExist(ByVal id As Integer) As Boolean 
    ' Code goes here. 
End Function

См. также

Ссылки

Рекомендуется использовать XML-теги для комментариев документации (Visual Basic)