Commentaires de documentation XML (Guide de programmation C#)

Mise à jour : novembre 2007

Dans Visual C#, vous pouvez créer la documentation pour votre code en incluant des balises XML dans les champs de commentaires spéciaux du code source directement avant le bloc de code auquel elles se réfèrent. Par exemple :

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

Lorsque vous utilisez /doc pour compiler, le compilateur recherche toutes les balises XML dans le code source et crée un fichier de documentation XML.

Remarque :
Les commentaires de documentation XML ne sont pas des métadonnées. Ils ne sont pas inclus dans l'assembly compilé et ne sont donc pas accessibles par réflexion.

Dans cette section

• Balises recommandées pour commentaires de documentation

• Traitement du fichier XML

• Délimiteurs pour les balises de documentation

• Comment : utiliser les fonctionnalités de la documentation XML

Rubriques connexes

Pour plus d'informations, consultez :

• /doc (Traiter les commentaires de documentation)

• Documentation XML, exemple

Spécification du langage C#

Pour plus d'informations, consultez les sections suivantes dans Spécifications du langage C#.

• Annexe A Commentaires de documentation

Voir aussi

Concepts

Guide de programmation C#