Share via

<parametr (> Visual Basic)

  • Článek

Definuje název a popis parametru.

Syntaxe

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

Parametry

name
Název parametru metody. Uzavřete název do dvojitých uvozovek (" ").

description
Popis parametru.

Poznámky

Značka <param> by měla být použita v komentáři pro deklaraci metody popisovat jeden z parametrů metody.

Text značky <param> se zobrazí v následujících umístěních:

Zkompilujte pomocí -doc a zpracujte komentáře dokumentace k souboru.

Příklad

Tento příklad používá <param> značku k popisu parametru 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

Viz také