<seealso> (Visual Basic)

Article
09/12/2008

Mise à jour : novembre 2007

Spécifie un lien qui apparaît à la section Voir aussi.

<seealso 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 la sortie XML. member doit être placé entre guillemets doubles (" ").

Notes

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

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

Exemple

Cet exemple utilise les balises <seealso> dans la section Notes DoesRecordExist pour faire référence à la méthode UpdateRecord.

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

Partager via