Condividi tramite

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

  • Articolo

Il compilatore C# elabora i commenti relativi alla documentazione nel codice e li formatta come XML in un file cui il nome viene specificato nell'opzione della riga di comando /doc.Per creare la documentazione finale basata sul file generato dal compilatore, è possibile creare uno strumento personalizzato, o utilizzare uno strumento come Sandcastle.

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 vengano visualizzate parentesi angolari, utilizzare &lt; e &gt;, come illustrato nell'esempio che segue.

/// <summary cref="C &lt; T &gt;">
/// </summary>

Vedere anche

Riferimenti

/doc (opzioni del compilatore C#)

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

Concetti

Guida per programmatori C#