Empfohlene Tags für Dokumentationskommentare (C#-Programmierhandbuch)Recommended Tags for Documentation Comments (C# Programming Guide)

Der C#-Compiler verarbeitet Dokumentationskommentare in Ihrem Code und formatiert diese als XML in einer Datei, deren Namen Sie in der Befehlszeilenoption /doc angeben.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. 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.To create the final documentation based on the compiler-generated file, you can create a custom tool, or use a tool such as Sandcastle.

Tags werden auf der Basis von Codekonstrukten wie Typen und Typmembern verarbeitet.Tags are processed on code constructs such as types and type members.

Hinweis

Dokumentationskommentare können nicht auf einen Namespace angewendet werden.Documentation comments cannot be applied to a namespace.

Der Compiler verarbeitet alle Tags, die gültige XML sind.The compiler will process any tag that is valid XML. Die folgenden Tags stellen allgemein verwendete Funktionen in der Benutzerdokumentation bereit.The following tags provide generally used functionality in user documentation.

TagsTags

<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>

(* gibt an, dass der Compiler die Syntax überprüft.)(* denotes that the compiler verifies syntax.)

Wenn Sie möchten, dass im Text eines Dokumentationskommentars spitze Klammern erscheinen, verwenden Sie < und >, wie im folgenden Beispiel gezeigt.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>  

Siehe auchSee Also

C#-ProgrammierhandbuchC# Programming Guide
/ doc (C#-Compileroptionen)/doc (C# Compiler Options)
XML-DokumentationskommentareXML Documentation Comments