Tag consigliati per i commenti relativi alla documentazione (Guida per programmatori C#)Recommended Tags for Documentation Comments (C# Programming Guide)

Il compilatore C# elabora i commenti alla documentazione nel codice e li formatta come XML in un file il cui nome è stato specificato nell'opzione della riga di comando /doc.The C# compiler processes documentation comments in your code and formats them as XML in a file whose name you specify in the /doc command-line option. Per creare la documentazione finale basata sul file generato dal compilatore, è possibile creare uno strumento personalizzato o usare uno strumento come Sandcastle.To create the final documentation based on the compiler-generated file, you can create a custom tool, or use a tool such as Sandcastle.

I tag vengono elaborati in costrutti di codice come tipi e membri dei tipi.Tags are processed on code constructs such as types and type members.

Nota

Non è possibile applicare a uno spazio dei nomi i commenti relativi alla documentazione.Documentation comments cannot be applied to a namespace.

Il compilatore elabora tutti i tag validi per XML.The compiler will process any tag that is valid XML. I tag seguenti forniscono le funzionalità comunemente usate nella documentazione dell'utente.The following tags provide generally used functionality in user documentation.

TagTags

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

* indica che il compilatore esegue la verifica della sintassi.(* denotes that the compiler verifies syntax.)

Se si vuole che nel testo di un commento alla documentazione vengano visualizzate parentesi angolari, usare < e >, come illustrato nell'esempio seguente.If you want angle brackets to appear in the text of a documentation comment, use < and >, as shown in the following example.

/// <summary cref="C < T >">  
/// </summary>  

Vedere ancheSee Also