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

<remarks> (Visual Basic)

  • Статья

Задает раздел примечаний для члена.

<remarks>description</remarks>

Параметры

  • description
    Описание члена.

Заметки

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

Эта информация отображается в обозревателе объектов.Дополнительные сведения об обозревателе объектов см. в разделе Просмотр структуры кода.

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

Пример

В этом примере используется тег <remarks>, чтобы объяснить, что делает метод 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)