<param> (Visual Basic)

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

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

Параметры

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

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

Заметки

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

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

• Сведения о параметрах IntelliSense. Дополнительные сведения см. в разделе Использование технологии 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-теги для комментариев документации (Visual Basic)