<see> (Visual Basic)

  • Article

Spécifie un lien vers un autre membre.

<see cref="member"/>

Paramètres

  • member
    Référence à un membre ou un champ qu'il est possible d'appeler depuis l'environnement de compilation actuel.Le compilateur vérifie que l'élément de code donné existe et passe member au nom d'élément dans le XML de sortie.member doit apparaître dans des guillemets doubles (" ").

Notes

Utilisez la balise <see> pour spécifier un lien à partir de l'intérieur du texte.Utilisez <seealso> (Visual Basic) pour indiquer du texte que vous souhaitez voir apparaître dans une section « Voir aussi ».

Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.

Exemple

Cet exemple utilise les balises <see> dans la section Notes UpdateRecord pour faire référence à la méthode 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

Voir aussi

Référence

Balises XML recommandées pour les commentaires de documentation (Visual Basic)