/doc (Options du compilateur C#)
L'option /doc vous permet de placer des commentaires de documentation dans un fichier XML.
/doc:file
Arguments
- file
Fichier de sortie XML contenant les commentaires extraits des fichiers de code source de la compilation.
Notes
Dans les fichiers de code source, les commentaires de documentation qui précèdent les éléments suivants peuvent être traités et ajoutés au fichier XML :
Des types définis par l'utilisateur, tels qu'une classe, un délégué ou une interface
Des membres, tels qu'un champ, un événement, une propriété ou une méthode
Le fichier de code source qui contient Main est traité en premier pour être placé dans le fichier XML.
Pour utiliser le fichier .xml généré avec la fonctionnalité IntelliSense, donnez au fichier .xml le même nom de fichier que celui de l'assembly que vous voulez prendre en charge et assurez-vous qu'il se trouve dans le même répertoire que l'assembly. De cette manière, lorsque l'assembly est référencé dans le projet Visual Studio, le fichier .xml est trouvé aussi. Pour plus d'informations, consultez Insertion de commentaires dans le code.
Sauf si vous compilez avec /target:module, file contiendra les balises <assembly></assembly> spécifiant le nom du fichier contenant le manifeste d'assembly pour le fichier de sortie de la compilation.
Notes
L'option /doc s'applique à tous les fichiers d'entrée ; ou, si elle est définie dans Paramètres du projet, à tous les fichiers du projet. Pour désactiver les avertissements relatifs aux commentaires de documentation pour un fichier spécifique ou une section de code, utilisez #pragma warning.
Pour découvrir des méthodes de génération de documentation à partir de commentaires contenus dans votre code, consultez Balises recommandées pour commentaires de documentation.
Pour définir cette option du compilateur dans l'environnement de développement Visual Studio
Ouvrez la page Propriétés du projet.
Cliquez sur l'onglet Générer.
Modifiez la propriété Fichier de documentation XML.
Pour plus d'informations sur la définition de cette option du compilateur par programme, consultez DocumentationFile.