(0) exportieren Drucken
Alle erweitern

XML-Dokumentationskommentare (C#-Programmierhandbuch)

Aktualisiert: November 2007

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. Beispiel:

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

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.

Weitere Informationen finden Sie in den folgenden Abschnitten von C#-Programmiersprachenspezifikation:

  • Anhang A "Dokumentationskommentare"

Community-Beiträge

HINZUFÜGEN
Anzeigen:
© 2014 Microsoft