Tag consigliati per i commenti relativi alla documentazione (Visual C++)

  • Articolo

Il compilatore di Visual C++ elabora i commenti della documentazione nel codice e crea un file xdc per ogni modulo e xdcmake.exe elabora i file xdc a un file xml.Elaborare il file xml per creare la documentazione è un dettaglio che deve essere distribuita al sito.

I tag vengono elaborati i costrutti come tipi e membri di tipo.

I tag devono trovarsi immediatamente prima i tipi o membri.

[!NOTA]

I commenti della documentazione non possono essere applicati a uno spazio dei nomi o sulla definizione della riga per le proprietà e gli eventi; i commenti della documentazione devono nelle dichiarazioni di classe in.

Il compilatore elabora tutti i tag validi per XML.I seguenti tag forniscono la funzionalità più comuni nella documentazione per l'utente:

<c>

<code>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>1

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<value>

 

 

1.Il compilatore verifica la sintassi.

Nella versione corrente, il compilatore di Visual C++ non supporta <paramref>, un tag supportato da altri compilatori di Visual Studio.Visual C++ può supportare <paramref> in una versione futura.

Vedere anche

Altre risorse

Documentazione XML (Visual C++)