-médecin

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

Syntaxe

-doc[+ | -]  

ou

-doc:file  

Les arguments

Terme	Définition
+ | -	Optionnel. En spécifiant +, ou simplement -doc, le compilateur génère des informations de documentation et le place dans un fichier XML. La spécification - est l’équivalent de ne pas spécifier -doc, ce qui entraîne la création d’aucune information de documentation.
file	Obligatoire si -doc: elle est utilisée. Spécifie le fichier XML de sortie, rempli avec les commentaires des fichiers de code source de la compilation. Si le nom de fichier contient un espace, entourez le nom de guillemets ( » « ).

Remarques

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

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

• Types définis par l’utilisateur, tels qu’une classe ou une interface

• Membres, tels qu’un champ, un événement, une propriété, une fonction ou une sous-routine.

Pour utiliser le fichier XML généré avec la fonctionnalité Visual Studio IntelliSense , laissez le nom de fichier du fichier XML 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 afin que lorsque l’assembly soit référencé dans le projet Visual Studio, le fichier .xml est également trouvé. Les fichiers de documentation XML ne sont pas requis pour que IntelliSense fonctionne pour le code au sein d’un projet ou dans des projets référencés par un projet.

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

Consultez les balises de commentaires XML pour obtenir des moyens de générer de la documentation à partir de commentaires dans votre code.

Pour définir -doc dans l’environnement de développement intégré Visual Studio
1. Avoir un projet sélectionné 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 un fichier de documentation XML .

Exemple :

Consultez La documentation de votre code avec XML pour obtenir un exemple.

Voir aussi

• Compilateur visual Basic Command-Line
• Documentation de votre code avec XML