<paramref> (Visual Basic)

Formatiert ein Wort als Parameter.

Syntax

<paramref name="name"/>  

Die Parameter

name
Der Name des Parameters, auf den verwiesen werden soll. Setzen Sie den Namen in doppelte Anführungszeichen (" ").

Bemerkungen

Mit dem <paramref> Tag können Sie angeben, dass ein Wort ein Parameter ist. Die XML-Datei kann so verarbeitet werden, dass dieser Parameter auf unterschiedliche Weise formatiert wird.

Kompilieren Sie mit -doc , um Dokumentationskommentare in einer Datei zu verarbeiten.

Beispiel

In diesem Beispiel wird das <paramref> Tag verwendet, um auf den id Parameter zu verweisen.

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

Siehe auch

• XML-Kommentartags