Commentaires de documentation XML (Guide de programmation C#)
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.Pour créer la documentation finale qui est basée sur le fichier généré par le compilateur, vous pouvez créer un outil personnalisé ou utiliser un outil de type Sandcastle.
[!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
Rubriques connexes
Pour plus d'informations, consultez :
Spécification du langage C#
Pour plus d'informations, consultez la Spécification du langage C#. La spécification du langage est la source de référence pour la syntaxe C# et son utilisation.