/doc
Traite les commentaires de documentation pour les diriger vers un fichier XML.
/doc[+ | -]
' -or-
/doc:file
Arguments
Terme |
Définition |
+ | - |
Facultatif.Si vous spécifiez +, ou simplement /doc, le compilateur générera des informations de documentation et les placera dans un fichier XML.La spécification de - revient à ne pas spécifier /doc ; ainsi, aucune information de documentation n'est créée. |
file |
Requis si /doc: est utilisé.Spécifie le fichier de sortie XML, qui est rempli avec les commentaires extraits des fichiers de code source de la compilation.Si le nom de fichier contient un espace, placez-le entre guillemets (" "). |
Notes
L'option /doc contrôle si le compilateur génère un fichier XML contenant des 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 tire le nom du fichier XML à partir du fichier exécutable ou de la bibliothèque que le compilateur crée.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, 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
Des 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é IntelliSense de Visual Studio, autorisez le nom du fichier XML à être identique à celui de l'assembly que vous souhaitez prendre en charge.Assurez-vous que le fichier XML est dans le même répertoire que l'assembly afin que le fichier .xml soit également recherché lorsque l'assembly est référencé dans le projet Visual Studio.Les fichiers de documentation XML ne sont pas requis pour qu'IntelliSense fonctionne pour le code dans un projet ou dans des projets référencés par un projet.
À moins que vous compiliez 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 Balises XML recommandées pour les commentaires de documentation (Visual Basic) pour savoir comment générer la documentation à partir de commentaires dans votre code.
Pour définir /doc dans l'environnement de développement intégré de Visual Studio |
|
Exemple
Consultez Documentation de votre code avec le langage XML (Visual Basic) pour obtenir un exemple.
Voir aussi
Concepts
Documentation de votre code avec le langage XML (Visual Basic)