18 Dokumentationskommentare

Wie Java unterstützt auch C# eine spezielle Form von Kommentaren, aus denen der Compiler automatisch Dokumentationsdateien in XML generieren kann. Kommentare dieser Art beginnen mit drei Schrägstrichen in jeder Zeile und müssen unmittelbar vor die Deklaration eines Programmelements gesetzt werden, z.B.:

/// ... Kommentar für MyClass ...class MyClass {   /// ... Kommentar für Foo...   public void Foo() {...}   ...}

Wenn eine Datei mit der /doc-Option übersetzt wird

csc /doc:MyClass.xml MyClass.cs

erzeugt der Compiler aus den Spezialkommentaren eine Dokumentationsdatei (hier MyClass.xml) im XML-Format. Daraus kann später mit anderen Werkzeugen, z.B. mit XSL (Extensible Stylesheet Language) und CSS (Cascading Stylesheets ...

Get Kompaktkurs C# 5.0, 4th Edition now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.