Tag consigliati per i commenti relativi alla documentazione

Il compilatore MSVC elabora i commenti della documentazione nel codice per creare un file XDC per ogni file di origine compilato. Xdcmake.exe elabora quindi i file XDC per creare un file di documentazione XML. L'elaborazione del file XML per creare la documentazione è un dettaglio che deve essere implementato nel sito.

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

I tag devono immediatamente precedere tipi o membri.

Nota

I commenti della documentazione non possono essere applicati a uno spazio dei nomi o a definizioni fuori riga per proprietà ed eventi; i commenti della documentazione devono trovarsi nelle dichiarazioni in classe.

Il compilatore elabora tutti i tag validi per XML. I tag seguenti forniscono le funzionalità comunemente usate nella documentazione dell'utente:

<c>
<code>
<example>
<exception>¹
<include>¹
<list>
<para>
<param>¹
<paramref>¹
<permission>¹
<remarks>
<returns>
<see>¹
<seealso>¹
<summary>
<value>

1. Il compilatore verifica la sintassi.

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

Vedi anche

Documentazione XML