Balises recommandées pour les commentaires de documentation (Visual C++)

  • Article

Le compilateur Visual C++ traitera les commentaires de documentation dans votre code et crée un fichier .xdc pour chaque module (compiland), et xdcmake.exe traitera les fichiers .xdc à un fichier .xml.Traiter le fichier .xml pour créer la documentation est un détail qui doit être implémenté à votre site.

Les balises sont traitées sur des éléments tels que des types et des membres de type.

Les balises doivent immédiatement précéder des types ou des membres.

[!REMARQUE]

Les commentaires de documentation ne peuvent pas être appliqués à un espace de noms ou en fonction hors de la définition de ligne pour les propriétés et les événements ; les commentaires de documentation doivent sur les déclarations de classe dans.

Le compilateur traite n'importe quelle balise représentant du XML correct.Les balises suivantes fournissent les fonctionnalités couramment utilisées dans la documentation utilisateur :

<c>

<code>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>1

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<value>

 

 

1.Le compilateur vérifie la syntaxe.

Dans la version actuelle, le compilateur Visual C++ ne prend pas <paramref>, une balise qui est prise en charge par d'autres compilateurs Visual Studio.Visual C++ peut prendre en charge <paramref> dans une version ultérieure.

Voir aussi

Autres ressources

Documentation XML (Visual C++)