Quali sono i tag della documentazione C#?[Chiuso]

Question

Nella documentazione C# i tag consentono di produrre output simili a MSDN.Qual è l'elenco dei tag consentiti da utilizzare all'interno dell'area commenti /// (tripla barra) sopra classi, metodi e proprietà?

Answer 1

Guardare Ottima documentazione sui vari tag di documentazione XML C#. (Vai in fondo per vedere i tag)

Answer 2

Se lo digiti appena sopra un metodo o una classe, intellisense dovrebbe chiederti un elenco di tag disponibili:

/// <

Answer 3

Ecco un elenco:

• riepilogo
• param
• ritorna
• esempio
• codice
• Vedere
• Guarda anche
• elenco
• valore
• file
• diritto d'autore

Ecco un esempio:

<file>
<copyright>(c) Extreme Designers Inc. 2008.</copyright>
<datecreated>2008-09-15</datecreated>
<summary>
Here's my summary
</summary>
<remarks>
<para>The <see cref="TextReader"/> can be used in the following ways:</para>
<list type="number">
<item>first item</item>
<item>second item</item>
</list>
</remarks>
<example>
<code>
System.Console.WriteLine("Hello, World");
</code>
</example>
<param name="aParam">My first param</param>
<returns>an object that represents a summary</returns>
</file>

Answer 4

Articolo MSDN del 2002 che descrive in dettaglio tutti i tag e quando utilizzarli:

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 5

GhostDoc aiuta creando un commento stub per il tuo metodo/classe.

Answer 6

Vedi l'eccellente articolo di MSDN Qui come prima tappa.

Answer 7

Cerca all'interno dei documenti Castello di sabbia.Questo è il nuovo standard di documentazione per .NET.