XML-Dokumentationskommentare (C#-Programmierhandbuch)

In Visual C# lässt sich eine Dokumentation des Codes erstellen. Dazu werden XML-Tags in spezielle Kommentarfelder des Quellcodes unmittelbar vor dem Codeblock eingefügt, auf den sie sich beziehen.Beispiele:

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

Wenn Sie mit /doc kompilieren, sucht der Compiler alle XML-Tags im Quellcode und erstellt eine XML-Dokumentationsdatei.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.

Hinweis
XML-Dokumentkommentare sind keine Metadaten und sind nicht in der kompilierten Assembly enthalten. Folglich ist der Zugriff auf sie über Reflektion nicht möglich.

In diesem Abschnitt

• Empfohlene Tags für Dokumentationskommentare

• Verarbeiten der XML-Datei

• Trennzeichen für Dokumentationstags

• Gewusst wie: Verwenden der XML-Dokumentationsfeatures

Verwandte Abschnitte

Weitere Informationen finden Sie unter:

• /doc (Dokumentationskommentare verarbeiten)

C#-Programmiersprachenspezifikation

Weitere Informationen finden Sie in der C#-Sprachspezifikation. Die Sprachspezifikation ist die verbindliche Quelle für die Syntax und Verwendung von C#.

Siehe auch

Konzepte

C#-Programmierhandbuch