/doc (Traiter les commentaires de documentation) (C/C++)

  • Article

Le compilateur traite les commentaires de documentation dans les fichiers de code source et crée un fichier .xdc pour chaque fichier de code source qui contient des commentaires de documentation.

Syntaxe

/doc[name]

Arguments

name
Nom du fichier .xdc que le compilateur va créer. Valide uniquement quand un fichier .cpp est transmis dans la compilation.

Notes

Les fichiers .xdc sont traités en fichier .xml avec xdcmake.exe. Pour plus d’informations, consultez référence XDCMake.

Vous pouvez ajouter des commentaires de documentation à vos fichiers de code source. Pour plus d’informations, consultez Balises recommandées pour commentaires de documentation.

Pour utiliser le fichier .xml généré avec IntelliSense, faites en sorte que le nom de fichier .xml soit le même que l’assembly que vous souhaitez prendre en charge et placez le fichier .xml 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 trouvé. Pour plus d’informations, consultez Utilisation d’IntelliSense et de la fourniture de commentaires de code XML.

Pour définir cette option du compilateur dans l'environnement de développement Visual Studio

  1. Ouvrez la boîte de dialogue Pages de propriété du projet. Pour plus d’informations, consultez Définir le compilateur C++ et les propriétés de build dans Visual Studio.

  2. Sélectionnez la page de propriétés Propriétés de configuration>C/C++>Fichiers de sortie.

  3. Modifiez la propriété Générer des fichiers de documentation XML.

Pour définir cette option de l'éditeur de liens par programmation

Voir aussi

Options du compilateur MSVC
Syntaxe de la ligne de commande du compilateur MSVC