Was sind die C # Dokumentation Tags? [geschlossen]

Question

In C # Dokumentation Tags können Sie eine Ausgabe ähnlich MSDN erzeugen. Was ist eine Liste der zulässigen Tags für den Einsatz im /// (Triple Slash) Kommentarbereich über die Klassen, Methoden und Eigenschaften?

Answer 1

Sehen Sie sich Große Dokumentation über die verschiedenen C # XML-Dokumentation Tags. (zum Ende der Tags sehen)

Answer 2

Wenn Sie diese direkt über ein Verfahren oder eine Klasse, intellisense sollten Sie mit einer Liste der verfügbaren Tags aufgefordert:

/// <

Answer 3

Hier ist eine Liste:

• Zusammenfassung
• param
• Rückgabe
• Beispiel
• Code
• sehen
• seealso
• Liste
• Wert
• Datei
• copyright

Hier ist ein Beispiel:

<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

MSDN-Artikel aus dem Jahr 2002 detailliert alle Tags und wenn sie zu benutzen:

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

Answer 5

GhostDoc hilft durch einen Stub-Kommentar für Ihre Methode / Klasse zu schaffen.

Answer 6

Sehen Sie den ausgezeichneten MSDN-Artikel hier als erste Adresse.

Answer 7

Blick in die Dokumentation für Sandcastle . Dies ist der neue Dokumentationsstandard für .NET.