Share via

<paramref> (Visual Basic)

  • Artikel

Formatiert ein Wort als Parameter.

<paramref name="name"/>

Parameter

  • name
    der Name des Parameters, auf den verwiesen werden soll. Der Name muss in doppelte Anführungszeichen (" ") eingeschlossen werden.

Hinweise

Mit dem <paramref>-Tag können Sie angeben, dass es sich bei einem Wort um einen Parameter handelt. Die XML-Datei kann verarbeitet werden, um den Parameter in besonderer Weise zu formatieren.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.

Beispiel

In diesem Beispiel wird mit dem <paramref>-Tag auf den id-Parameter verwiesen.

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

Referenz

Empfohlene XML-Tags für Dokumentationskommentare (Visual Basic)