<seealso> balise de documentation

La <seealso> balise vous permet de spécifier le texte que vous souhaiterez peut-être afficher dans une section Voir également. Permet <see> de spécifier un lien à partir du texte.

Syntaxe

/// <seealso 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. Mettez le nom entre guillemets simples ou doubles.

Le compilateur vérifie que l’élément de code donné existe et qu’il résout member en nom d’élément dans le code XML de sortie. Le compilateur émet un avertissement s’il ne trouve memberpas .

Pour plus d’informations sur la création d’une cref référence à un type générique, consultez <see>.

Notes

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

Consultez <summary> un exemple d’utilisation <seealso>.

Le compilateur MSVC tente de résoudre cref les références dans un seul passage par le biais des commentaires de documentation. Si le compilateur ne trouve pas de symbole lors de l’utilisation des règles de recherche C++, il marque la référence comme non résolue.

Exemple

Dans l’exemple suivant, un symbole non résolu est référencé dans un cref. Le commentaire XML pour le cref to A::Test est bien formé : <seealso cref="M:A.Test" />. Cependant, le cref à B::Test devenir <seealso cref="!:B::Test" />.

// xml_seealso_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_seealso_tag.dll

/// Text for class A.
public ref struct A {
   /// <summary><seealso cref="A::Test"/>
   /// <seealso cref="B::Test"/>
   /// </summary>
   void MyMethod(int Int1) {}

   /// text
   void Test() {}
};

/// Text for class B.
public ref struct B {
   void Test() {}
};

Voir aussi

Documentation XML