<param> (Visual Basic)

Определяет имя и описание параметра.

Синтаксис

<param name="name">description</param>  

Параметры

name
Имя параметра метода. Имя заключается в двойные кавычки (" ").

description
Описание параметра.

Замечания

Тег <param> следует использовать в комментариях к объявлению метода для описания одного из параметров такого метода.

Текст тега <param> будет отображаться в следующих расположениях:

• Сведения о параметрах IntelliSense. Дополнительные сведения см. в разделе Using IntelliSense.

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

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

Пример

В этом примере тег используется <param> для описания id параметра.

''' <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-теги для комментариев