Condividi tramite

Tag consigliati per i commenti relativi alla documentazione (Guida per programmatori C#)

  • Articolo

Aggiornamento: novembre 2007

Il compilatore C# elabora i commenti per la creazione della documentazione presenti nel codice in un file XML. L'elaborazione di un file XML per la creazione della documentazione deve essere implementata a livello locale.

I tag vengono elaborati su determinati costrutti del codice, ad esempio i tipi e i membri dei tipi.

Nota:

Non è possibile applicare a uno spazio dei nomi i commenti relativi alla documentazione.

Il compilatore elabora tutti i tag validi per XML. I tag riportati di seguito forniscono le funzionalità più comunemente utilizzate nella documentazione per l'utente.

Tag

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

* indica che il compilatore esegue la verifica della sintassi.

Se si desidera che nel testo di un commento relativo alla documentazione siano incluse le parentesi angolari, utilizzare &lt; e &gt;. Ad esempio, &lt;testo in parentesi angolari&gt;.

Vedere anche

Attività

Esempio di documentazione XML

Concetti

Guida per programmatori C#

Riferimenti

/doc (elaborazione dei commenti per la documentazione) (opzioni del compilatore C#)

Commenti relativi alla documentazione XML (Guida per programmatori C#)