Freigeben über

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

  • Artikel

Der C#-Compiler verarbeitet Dokumentationskommentare im Code und formatiert sie als XML in einer Datei, deren Namen Sie mit der Befehlszeilenoption /doc angeben können. 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 für Codekonstrukte wie Typen und Typenmember verarbeitet.

Tipp

Dokumentationskommentare können nicht für einen Namespace übernommen werden.

Der Compiler verarbeitet jedes Tag, das gültiges XML darstellt. Die folgenden Tags stellen in Benutzerdokumentationen häufig verwendete Funktionen bereit:

Tags

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

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

Wenn Sie spitze Klammern im Text eines Dokumentationskommentars haben möchten, verwenden Sie &lt; und &gt;, wie im folgenden Beispiel gezeigt.

/// <summary cref="C &lt; T &gt;">

Siehe auch

Referenz

/doc (C#-Compileroptionen)

XML-Dokumentationskommentare (C#-Programmierhandbuch)

Konzepte

C#-Programmierhandbuch