Dela via

<se> (Visual Basic)

  • Artikel

Anger en länk till en annan medlem.

Syntax

<see cref="member"/>

Parametrar

member
En referens till en medlem eller ett fält som är tillgängligt för att anropas från den aktuella kompileringsmiljön. Kompilatorn kontrollerar att det angivna kodelementet finns och skickar member till elementnamnet i xml-utdata. member måste visas inom dubbla citattecken (" ").

Kommentarer

Använd taggen <see> för att ange en länk inifrån text. Använd <seealso för> att ange text som du kanske vill ska visas i avsnittet "Se även".

Kompilera med -doc för att bearbeta dokumentationskommentare till en fil.

Exempel

I det här exemplet används taggen <see> i kommentarsavsnittet UpdateRecord för att referera till DoesRecordExist metoden.

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

Se även