Share via

<see> (Visual Basic)

  • Artikel

Gibt einen Link zu einem anderen Member an.

<see cref="member"/>

Parameter

  • member
    Ein Verweis auf einen Member oder ein Feld, der bzw. das von der aktuellen Kompilierungsumgebung aufgerufen werden kann. Der Compiler überprüft, ob das angegebene Codeelement vorhanden ist, und übergibt member an den Elementnamen in der XML-Ausgabe. member muss in doppelte Anführungszeichen (" ") eingeschlossen werden.

Hinweise

Mit dem <see>-Tag wird ein Link im Text angegeben. Mit <seealso> (Visual Basic) wird Text angegeben, der in einem "Siehe auch"-Abschnitt angezeigt werden soll.

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

Beispiel

In diesem Beispiel verweist das <see>-Tag im UpdateRecord-Hinweisabschnitt auf die DoesRecordExist-Methode.

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