Главная » Статьи » Visual Basic » Библиотека Visual Basic
<remarks> (Visual Basic)
Задает раздел примечаний для члена.

<remarks>description</remarks>

Параметры

description

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

Заметки

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

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

Пример

В этом примере используется тег <remarks>, чтобы объяснить, что делает метод UpdateRecord.

VB

''' <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

Источник: http://expert1.ucoz.com/
Категория: Библиотека Visual Basic | Добавил: hitman (07.04.2012)
Просмотров: 1365 | Теги: vb library | Рейтинг: 0.0/0
Всего комментариев: 0
Имя *:
Email *:
Код *: