Partager via


<see> (Guide de programmation C#)

<see cref="member"/>

Paramètres

  • cref = " 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.Placez le membre entre guillemets doubles ("").

Notes

La balise <see> permet de spécifier un lien à partir de l'intérieur du texte. Utilisez <seealso> pour indiquer que le texte doit être placé dans une section « Voir aussi ». Utilisez attribut cref pour créer des liens hypertexte internes aux pages de documentation pour les éléments de code.

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

L'exemple suivant affiche une balise <voir> dans une section Résumé.

// compile with: /doc:DocFileName.xml  

/// text for class TestClass 
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class. 
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary> 
    public static void DoWork(int Int1)
    {
    }

    /// text for Main 
    static void Main()
    {
    }
}

Voir aussi

Référence

Balises recommandées pour commentaires de documentation (Guide de programmation C#)

Concepts

Guide de programmation C#