<param> (Visual Basic)

Hiermee definieert u een parameternaam en beschrijving.

Syntaxis

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

Parameters

name
De naam van een methodeparameter. Plaats de naam tussen dubbele aanhalingstekens (" ").

description
Een beschrijving voor de parameter.

Opmerkingen

De <param> tag moet worden gebruikt in de opmerking voor een methodedeclaratie om een van de parameters voor de methode te beschrijven.

De tekst voor de <param> tag wordt weergegeven op de volgende locaties:

• Parametergegevens van IntelliSense. Zie IntelliSense gebruiken voor meer informatie.

• Objectbrowser. Zie De structuur van code bekijken voor meer informatie.

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

Opmerking

In dit voorbeeld wordt de <param> tag gebruikt om de id parameter te beschrijven.

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