Balises recommandées pour les commentaires de documentation
Le compilateur MSVC traite les commentaires de documentation dans votre code pour créer un fichier XDC pour chaque fichier source compilé. Ensuite, xdcmake.exe traite les fichiers XDC pour créer un fichier de documentation XML. Le traitement du fichier XML pour créer une documentation est un détail qui doit être implémenté sur votre site.
Les balises sont traitées sur des constructions telles que les types et les membres de type.
Les balises doivent immédiatement précéder les types ou membres.
Remarque
Les commentaires de documentation ne peuvent pas être appliqués à un espace de noms ou à des définitions hors ligne pour les propriétés et les événements ; les commentaires de documentation doivent se trouver sur les déclarations dans la classe.
Le compilateur traite toute balise représentant du code 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>
- Le compilateur vérifie la syntaxe.
Dans la version actuelle, le compilateur MSVC ne prend pas en charge <paramref>
, une balise prise en charge par d’autres compilateurs Visual Studio. Visual C++ peut prendre en charge <paramref>
dans une version ultérieure.
Voir aussi
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : pendant toute l’année 2024, nous allons éliminer progressivement Problèmes GitHub comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, voir :Soumettre et afficher des commentaires pour