Partager via

<summary> (Guide de programmation C#)

  • Article

Mise à jour : novembre 2007

<summary>description</summary>

Paramètres

  • description
    Résumé de l'objet.

Notes

La balise <summary> doit être utilisée pour décrire un type ou un membre d'un type. Utilisez <remarks> pour ajouter des informations complémentaires à une description de type.

Le texte de la balise <summary> est la seule source d'information sur le type dans IntelliSense. Il est également affiché dans l'Explorateur d'objets.

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

Exemple

// 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

Concepts

Guide de programmation C#

Référence

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