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

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.Um die endgültige Dokumentation auf Grundlage der vom Compiler generierte Datei zu erstellen, können Sie ein benutzerdefiniertes Tool erstellen, oder verwenden Sie ein Tool wie Sandburg.

Tags werden für Codekonstrukte wie Typen und Typenmember verarbeitet.

HinweisHinweis

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;">
/// </summary>

Siehe auch

Referenz

/doc (C#-Compileroptionen)

XML-Dokumentationskommentare (C#-Programmierhandbuch)

Konzepte

C#-Programmierhandbuch

  • Last updated on