<see> (Visual Basic)

Specifica un collegamento a un altro membro.

Sintassi

<see cref="member"/>  

Parametri

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

Osservazioni:

Usare il <see> tag per specificare un collegamento dal testo. Usare <seealso> per indicare il testo che si potrebbe voler visualizzare in una sezione "Vedere anche".

Compilare con -doc per elaborare i commenti della documentazione in un file.

Esempio

In questo esempio viene usato il <see> tag nella UpdateRecord sezione osservazioni per fare riferimento al DoesRecordExist metodo .

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

• Tag di commento XML