Partager via

-doc

  • Article

Traite les commentaires de documentation pour les diriger vers un fichier XML.

Syntaxe

-doc[+ | -]

ou

-doc:file

Arguments

Terme Définition
+ | - Optionnel. Si vous spécifiez +, ou simplement -doc, le compilateur génère des informations de documentation et les place dans un fichier XML. Si vous spécifiez -, ce qui équivaut à ne pas spécifier -doc, aucune information de documentation n’est créée.
file Obligatoire si l'option -doc: est utilisée. Spécifie le fichier XML de sortie, qui est renseigné avec les commentaires des fichiers de code source de la compilation. Si le nom de fichier contient un espace, placez-le entre des guillemets (" ").

Notes

L’option -doc contrôle si le compilateur génère un fichier XML contenant les commentaires de documentation. Si vous utilisez la syntaxe -doc:file, le paramètre file spécifie le nom du fichier XML. Si vous utilisez -doc ou -doc+, le compilateur prend le nom de fichier XML du fichier exécutable ou de la bibliothèque en cours de création. Si vous utilisez -doc- ou que vous ne spécifiez pas l’option -doc, le compilateur ne crée pas de fichier XML.

Dans les fichiers de code source, des commentaires de documentation peuvent précéder les définitions suivantes :

Pour utiliser le fichier XML généré avec la fonctionnalité IntelliSense de Visual Studio, faites en sorte que le nom du fichier XML soit identique à l’assembly que vous souhaitez prendre en charge. Vérifiez que le fichier XML se trouve dans le même répertoire que l’assembly. De cette façon, quand l’assembly est référencé dans le projet Visual Studio, le fichier .xml est aussi localisé. Les fichiers de documentation XML ne sont pas nécessaires au bon fonctionnement d’IntelliSense avec du code dans un projet ou dans des projets référencés par un projet.

Le fichier XML contient les balises <assembly></assembly>, sauf si vous effectuez la compilation avec -target:module. Ces balises spécifient le nom du fichier contenant le manifeste d’assembly pour le fichier de sortie de la compilation.

Pour découvrir comment générer de la documentation à partir de commentaires dans votre code, consultez Balises de commentaires XML.

Pour définir -doc dans l’environnement de développement intégré Visual Studio
1. Sélectionnez un projet dans l’Explorateur de solutions. Dans le menu Projet , cliquez sur Propriétés.
2. Cliquez sur l’onglet Compiler.
3. Définissez la valeur dans la zone Générer le fichier de documentation XML.

Exemple

Pour obtenir un exemple, consultez Documentation de votre code avec le langage XML.

Voir aussi