Condividi tramite

<see> (Visual Basic)

  • Articolo

Specifica un collegamento a un altro membro.

<see cref="member"/>

Parametri

  • member
    Riferimento a un membro o a un campo disponibile per essere chiamato dall'ambiente di compilazione corrente. Il compilatore verifica l'esistenza dell'elemento di codice specificato e passa member al nome di elemento nel file XML di output. Il parametro member deve essere visualizzato tra virgolette doppie (" ").

Note

Utilizzare il tag <see> per specificare un collegamento nel testo. Utilizzare <seealso> (Visual Basic) per indicare il testo che si desidera visualizzare in una sezione "Vedere anche".

Eseguire la compilazione con /doc per elaborare in un file i commenti relativi alla documentazione.

Esempio

Nell'esempio riportato di seguito il tag <see> viene utilizzato nella sezione relativa alle osservazioni di UpdateRecord per fare riferimento al metodo 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

Vedere anche

Riferimenti

Tag XML consigliati per i commenti relativi alla documentazione (Visual Basic)