Dela via

<param> (Visual Basic)

Definierar ett parameternamn och en beskrivning.

Syntax

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

Parametrar

name
Namnet på en metodparameter. Omslut namnet inom dubbla citattecken (" ").

description
En beskrivning av parametern.

Kommentarer

Taggen <param> ska användas i kommentaren för en metoddeklaration för att beskriva en av parametrarna för metoden.

Texten för taggen <param> visas på följande platser:

Kompilera med -doc för att bearbeta dokumentationskommentare till en fil.

Exempel

I det här exemplet används taggen <param> för att beskriva parametern 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

Se även