<paramref> (Visual Basic)

Hiermee wordt een woord opgemaakt als parameter.

Syntaxis

<paramref name="name"/>  

Parameterwaarden

name
De naam van de parameter waarnaar moet worden verwezen. Plaats de naam tussen dubbele aanhalingstekens (" ").

Opmerkingen

De <paramref> tag geeft u een manier om aan te geven dat een woord een parameter is. Het XML-bestand kan op een duidelijke manier worden verwerkt om deze parameter op te maken.

Compileer met -doc om documentatieopmerkingen naar een bestand te verwerken.

Voorbeeld

In dit voorbeeld wordt de <paramref> tag gebruikt om te verwijzen naar de id parameter.

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

Zie ook

• XML-opmerkingstags