Sdílet prostřednictvím

<see> (Visual Basic)

  • Článek

Určuje odkaz na jiného člena.

Syntaxe

<see cref="member"/>

Parametry

member
Odkaz na člena nebo na pole, které lze volat z prostředí aktuální kompilace. Kompilátor zkontroluje, zda daný element kódu existuje a předává member název elementu ve výstupním XML. member musí být uveden v uvozovkách (" ").

Poznámky

Pomocí značky <see> můžete zadat odkaz z textu. Pomocí <funkce seealso> můžete označit text, který se může zobrazit v části Viz také.

Zkompilujte pomocí -doc a zpracujte komentáře dokumentace k souboru.

Příklad

Tento příklad používá <see> značku v oddílu UpdateRecord poznámek k odkazování na metodu DoesRecordExist .

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

Viz také