XML documentation (Visual C++)

  • Article

Dans Visual C++, vous pouvez ajouter des commentaires à votre code source qui sont traités dans un fichier de documentation XML. Ce fichier peut ensuite être l’entrée d’un processus qui crée la documentation pour les classes dans votre code.

Dans un fichier de code Visual C++, les commentaires de documentation XML doivent se trouver directement avant une méthode ou une définition de type. Les commentaires peuvent être utilisés pour renseigner la bulle d’informations Info express IntelliSense dans les scénarios suivants :

  1. Lorsque le code est compilé en tant que composant Windows Runtime avec un fichier WINMD

  2. Lorsque le code source est inclus dans le projet actuel

  3. Dans une bibliothèque dont les déclarations de type et les implémentations se trouvent dans le même fichier d’en-tête

Remarque

Dans la version actuelle, les commentaires de code ne sont pas traités sur les modèles ou tout élément contenant un type de modèle (par exemple, une fonction prenant un paramètre en tant que modèle). L’ajout de ces commentaires entraîne un comportement non défini.

Pour plus d’informations sur la création d’un fichier XML avec des commentaires de documentation, consultez les articles suivants.

Pour obtenir des informations sur Consultez
Options du compilateur à utiliser /doc
Balises que vous pouvez utiliser pour fournir les fonctionnalités couramment utilisées dans la documentation Balises recommandées pour les commentaires de documentation
Chaînes d’ID que le compilateur produit pour identifier les constructions dans votre code Traitement du fichier XML
Procédure pour délimiter les balises de documentation Délimiteurs pour les balises de documentation Visual C++
Génération d’un fichier XML à partir d’un ou plusieurs fichiers XDC. Référence XDCMake
Liens vers des informations sur XML par rapport aux zones des fonctionnalités Visual Studio XML dans Visual Studio

Si vous devez placer des caractères spéciaux XML dans le texte d’un commentaire de documentation, vous devez utiliser des entités XML ou une section CDATA.

Voir aussi

Extensions de composant pour les plateformes d’exécution