21 Dokumentation einer Klasse
21.1 Wozu Dokumentationen?
 
Fachklassen und GUI Wir haben gesehen, dass man Fachklassen von den GUI trennt. In unserem Beispiel Mathematik und ihrer GUI kann so weit gehen, dass jemand, der eine GUI erstellt von der Fachklasse Mathematik eigentlich nur wenig kennen muss, nämlich die ihm zugänglichen (also public erklärten) Methoden, ihre Signatur und ihre Funktionalität. Wie die Methoden implementiert sind hat ihn nicht zu interessieren. Tatsächlich ist der GUI-Programmierer gar nicht an dem Quellcode der von ihm verwendeten Klassen interessiert, sondern nur an deren Compilat. Die Situation ist mit der vergleichbar, in der wir sind, wenn wir die Methoden der von SUN gelieferten Klasse Math benutzen wollen.  Wollen wir wissen, welche Methoden die Klasse Math zur Verfügung stellt, wie diese zu verwenden sind und was sie leisten, werfen wir einen Blick in die API:

 
 
Der Ausschnitt zeigt die beiden öffentlichen Attribute und einige Methoden. Wollen wir jemanden unsere Klasse Mathematik zur Verfügung stellen, ohne ihm einen Einblick zu geben, wie wir sie programmiert haben, müssen wir diesem Jemand eine API unserer Klasse in die Hand geben. Wie können wir dies aber ohne großen Aufwand leisten?

Mit  dem Programm javadoc.exe stellt j2sdkxxx von SUN(TM) ein komfortables Werkzeug zur Erstellung einer Benutzer-Dokumentation zur Verfügung. Mit ihr lässt sich von einer selbst geschriebenen Klasse eine Dokumentation erstellen, die der der Klasse Math in Aussehen und Informationsgehalt bis aufs Haar gleicht. Im Javaeditor ist diese Dokumentationserstellung und -nutzung hervorragend integriert.  Im nächsten Kapitel lernen wir drei Arten von Dokumentationen kennen, eine davon wird benutzt, eine API unserer Klasse zu gestlten?

 

zu 21.2 Dokumentationskommentare im Java-Quelltext
zur Startseite www.pohlig.de  (C) MPohlig 2004