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

  • Artikel

Aktualisiert: November 2007

Der C#-Compiler verarbeitet Dokumentationskommentare zu einer XML-Datei. Das Verarbeiten der XML-Datei zum Erstellen von Dokumentation ist ein Detail, das implementiert werden muss.

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

Hinweis:

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 im Text eines Dokumentationskommentars Winkelklammern darstellen möchten, verwenden Sie &lt; und &gt;. Zum Beispiel &lt;Text in Winkelklammern&gt;.

Siehe auch

Aufgaben

Beispiel für die XML-Dokumentation

Konzepte

C#-Programmierhandbuch

Referenz

/doc (Dokumentationskommentare verarbeiten) (C#-Compileroptionen)

XML-Dokumentationskommentare (C#-Programmierhandbuch)