Quelles sont les balises de documentation C #? [fermé]

Question

En C #, les balises de documentation vous permettent de produire une sortie similaire à MSDN. Quelle est la liste des balises autorisées à utiliser dans la zone de commentaire /// (triple barre oblique) au-dessus des classes, méthodes et propriétés?

Answer 1

Découvrez Excellente documentation sur les différentes balises de la documentation XML C #. (allez au bas de la page pour voir les balises)

Answer 2

Si vous tapez ceci juste au-dessus d'une méthode ou d'une classe, intellisense devrait vous demander une liste des balises disponibles:

/// <

Answer 3

Voici une liste:

• résumé
• param
• renvoie
• exemple
• code
• voir
• seealso
• liste
• valeur
• fichier
• copyright

Voici un exemple:

<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

Article MSDN de 2002 détaillant toutes les balises et leur utilisation:

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

Answer 5

GhostDoc permet de créer un commentaire de module de remplacement pour votre méthode / classe.

Answer 6

Voir l'excellent article MSDN ici lors de votre premier arrêt.

Answer 7

Recherchez dans Sandcastle la documentation correspondante. Ceci est le nouveau standard de documentation pour .NET.