<see> balise de documentation
La balise <see> vous permet de spécifier un lien à partir de l’intérieur du texte. Permet <seealso> d’indiquer le texte que vous souhaiterez peut-être afficher dans une section Voir également .
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. 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 .
Notes
Compilez avec /doc pour traiter les commentaires de documentation dans un fichier.
Pour obtenir un exemple d’utilisation <see>, consultez <summary>.
Le compilateur MSVC tente de résoudre cref les références dans un seul passage par les commentaires de documentation. Si le compilateur ne trouve pas de symbole lorsqu’il utilise les règles de recherche C++, il marque la référence comme non résolue. Pour plus d’informations, consultez <seealso>.
Exemple
L’exemple suivant montre comment faire cref référence à un type générique afin que le compilateur résolve la référence.
// xml_see_cref_example.cpp
// compile with: /LD /clr /doc
// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <see cref="C{T}">
/// </see>
ref class A {};
// the following cref shows another way to specify the reference,
// such that, the compiler will resolve the reference
/// <see cref="C < T >"/>
// the following cref shows how to hard-code the reference
/// <see cref="T:C`1">
/// </see>
ref class B {};
/// <see cref="A">
/// </see>
/// <typeparam name="T"></typeparam>
generic<class T>
ref class C {};