Empfohlene Tags für Dokumentationskommentare (C#-Programmierhandbuch)

Der C#-Compiler verarbeitet Dokumentationskommentare in Ihrem Code und formatiert diese als XML in einer Datei, deren Namen Sie in der Befehlszeilenoption /doc angeben. Zum Erstellen der endgültigen Dokumentation auf Grundlage der vom Compiler generierten Datei können Sie ein benutzerdefiniertes Tool erstellen oder ein Tool wie Sandcastle verwenden.

Tags werden auf der Basis von Codekonstrukten wie Typen und Typmembern verarbeitet.

Hinweis

Dokumentationskommentare können nicht auf einen Namespace angewendet werden.

Der Compiler verarbeitet alle Tags, die gültige XML sind. Die folgenden Tags stellen allgemein verwendete Funktionen in der Benutzerdokumentation bereit.

Tags

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

(* gibt an, dass der Compiler die Syntax überprüft.)

Wenn Sie möchten, dass im Text eines Dokumentationskommentars spitze Klammern erscheinen, verwenden Sie < und >, wie im folgenden Beispiel gezeigt.

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

Siehe auch

C#-Programmierhandbuch
/doc (C#-Compileroptionen)
XML-Dokumentationskommentare