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# 4.0, 3rd Edition now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
