Documentation XML (Visual C++)
Dans Visual C++, vous pouvez ajouter des commentaires à votre code source qui sera traité dans un fichier .xml.Ce fichier peut ensuite être l'entrée à un processus qui crée la documentation pour les classes dans votre code.
Dans Visual C++ un fichier de code, des commentaires de documentation XML doivent être installés directement avant une méthode ou une définition de type.Les commentaires peuvent être utilisés pour renseigner fin de données Intellisense info express dans les scénarios suivants :
lorsque le code est compilé en tant que composant d'exécution windows avec un fichier accompagnant de .winmd
lorsque le code source est inclus dans le projet actuel
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 du code ne sont pas traités sur des modèles ou n'importe quoi contenant un type de modèle (par exemple, une fonction prenant un paramètre comme modèle).Ajout de ces commentaires entraîne le comportement non défini.
Pour plus d'informations sur la création d'un fichier .xml avec des commentaires de documentation, consultez les rubriques suivantes.
Pour plus d'informations sur |
Consultez |
|---|---|
Les options du compilateur à utiliser |
|
Balises que vous pouvez utiliser pour fournir aux fonctionnalités couramment utilisées dans la documentation |
|
Les chaînes d'ID que le compilateur produit pour identifier les éléments dans votre code |
|
Procédure et délimitent les balises de documentation |
|
Générer un fichier .xml à partir d'un ou plusieurs fichiers .xdc. |
|
Liens vers des informations sur XML par rapport à les fonctionnalités de Visual Studio |
Si vous devez placer des caractères spéciaux XML dans le texte de commentaire de documentation, vous devez utiliser des entités XML ou une section CDATA.