Leseprobe

142
Kommentarbasierte Dokumentation in XML
24: Info.Trace("Cool!");
25: Info.TraceX("{0} {1} {2}", "C", "U", 2001);
26: }
27: }
Die Klasse Info enthält zwei bedingte, auf das DEBUG-Symbol zugeschnittene Vereinbarungen
für statische Methoden: Trace, eine einparametrige Methode, und
TraceX, eine Methode, die mit einer flexiblen Anzahl von Parametern aufgerufen
werden kann. Über Trace gibt es weiter nichts zu sagen. Die Deklaration von TraceX
enthält hingegen den Zusatz params, den Sie vielleicht von Visual Basic her
kennen werden.
Indem Sie das Schlüsselwort params vor einen Arraybezeichner setzen, kann die
Methode eine beliebige Anzahl von Argumenten verarbeiten – vergleichbar mit
der Bedeutung der Ellipse »…« in C++. Zu beachten ist lediglich, dass Sie params
nur einmal und auch nur für den letzten Parameter in der Parameterliste einer
Methode verwenden dürfen. Beide Beschränkungen dürften sich aber von selbst
verstehen.
Hinter der Verwendung des params-Schlüsselworts steckt natürlich die Absicht,
eine Trace-Methode zu erhalten, deren Parameterschema, eine Formatzeichenfolge
in Kombination mit einer offenen Anzahl an Parameterwerten, genau auf
den Aufruf der WriteLine-Methode passt (Zeile 16).
Die Ausgabe des kleinen Programms wird ausschließlich durch das Symbol DEBUG
bestimmt. Ist das Symbol bekannt, übersetzt der Compiler die beiden Methoden
sowie ihre Aufrufe in der Methode Main, andernfalls nicht.
Bedingt definierte Methoden sind ein wirklich mächtiges Werkzeug, das es Ihnen
erlaubt, Ihre Anwendungen und Komponenten auf sehr einfache Weise mit
bedingter Funktionalität auszustatten. Mit ein paar zusätzlichen Schnörkeln können
Sie auch bedingte Methoden vereinbaren, die von mehreren Symbolen – verbunden
durch die logischen Operatoren && und || – abhängig sind. Details darüber
finden Sie in der C#-Dokumentation.
9.2 Kommentarbasierte Dokumentation in XML
Eine Aufgabe, die den wenigsten Programmierern wirklich Spaß macht, ist das
ausführliche Kommentieren und Dokumentieren ihrer Quelltexte. In C# steckt das
Potenzial, mit alten Gewohnheiten zu brechen: Sie können sich die Dokumentation
automatisiert aus den Kommentaren in Ihren Quelltexten generieren lassen.
Da der Compiler die Ausgabe im XML-Format liefert, lässt sie sich sowohl als
Eingabedatei für die weitergehende Dokumentation der Komponente verwenden
als auch als Informationsquelle für Werkzeuge, die Hilfe und implementatorische
Einblicke zu Ihren Komponenten verfügbar machen. Visual Studio 7 ist beispiels-