Бөлісу құралы:

<примечания> (Visual Basic)

  • Мақала

Указывает раздел примечаний для члена.

Синтаксис

<remarks>description</remarks>

Параметры

description
Описание элемента.

Замечания

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

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

Чтобы обработать комментарии документации и сохранить их в файл, выполняйте сборку с параметром -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

См. также