Partage via

<voir> (Visual Basic)

  • Article

Spécifie un lien vers un autre membre.

Syntaxe

<see cref="member"/>

Paramètres

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

Notes

Utilisez la balise <see> pour spécifier un lien à partir du texte. Utilisez <seealso> pour désigner le texte que vous souhaitez voir apparaître dans une section Voir aussi.

Compilez avec -doc pour placer les commentaires de documentation dans un fichier en vue de les traiter.

Exemple

Cet exemple utilise la balise <see> dans la section remarques 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