Freigeben über


<siehe> (Visual Basic)

Gibt einen Link zu einem anderen Element an.

Syntax

<see cref="member"/>  

Die Parameter

member
Ein Verweis auf ein Element oder Feld, das aus 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 doppelten Anführungszeichen (" ") angezeigt werden.

Bemerkungen

Verwenden Sie das <see> Tag, um einen Link aus Text anzugeben. Verwenden Sie <"Seealso> ", um Text anzugeben, der möglicherweise in einem Abschnitt "Siehe auch" angezeigt werden soll.

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

Beispiel

In diesem Beispiel wird das <see> Tag im UpdateRecord Abschnitt "Hinweise" verwendet, um auf die DoesRecordExist Methode 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