/doc (Traiter les commentaires de documentation) (C/C++)
Mise à jour : novembre 2007
Indique au compilateur de traiter les commentaires de documentation contenus dans les fichiers de code source et de créer un fichier .xdc pour chaque fichier de code source contenant commentaires de documentation.
/doc[name]
Arguments
- name
Nom du fichier .xdc que le compilateur doit créer. Uniquement valide lorsqu'un fichier .cpp est passé dans la compilation.
Notes
Les fichiers .xdc sont traités dans un fichier .xml avec xdcmake.exe. Pour plus d'informations, consultez XDCMake Reference.
Vous pouvez ajouter des commentaires de documentation à vos fichiers de code source. Pour plus d'informations, consultez Recommended Tags for Documentation Comments (Visual C++).
/doc n'est pas compatible avec /clr:oldSyntax. Pour plus d'informations, consultez /clr (Compilation pour le Common Language Runtime).
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. Lorsque l'assembly est référencé dans le projet Visual Studio, le fichier .xml est également détecté. Pour plus d'informations, consultez Utilisation de la fonctionnalité IntelliSense et Insertion de commentaires dans le code XML.
Pour définir cette option du compilateur dans l'environnement de développement Visual Studio
Ouvrez la boîte de dialogue Pages de propriété du projet. Pour plus d'informations, consultez Comment : ouvrir les pages de propriétés d'un projet.
Développez le nœud Propriétés de configuration.
Développez le nœud C/C++.
Sélectionnez la page de propriétés Fichiers de sortie.
Modifiez la propriété Génération de fichiers de documentation XML.
Pour définir cette option de l'éditeur de liens par programme
- Consultez GenerateXMLDocumentationFiles.