Haben Sie noch einwenig Zeit? Haben Sie auch noch einwenig Zeit, wenn Sie nun eine Dokumentation Ihrer Arbeit erstellen müssen? Welcher Programmierer kennt es nicht, das Problem mit der Dokumentation? Wenn endlich einmal das Programm so läuft wie es soll, kann man sich nicht gleich neuen, interessanten Aufgaben zuwenden. Nein, man sollte die Arbeit noch dokumentieren.
Auf der anderen Seite haben Sie sich sicher auch schon geärgert über unvollständige, veraltete, fehlerhafte oder gar fehlende Dokumentationen eines Produktes oder Programmes das Sie selbst benutzen. In diesem Posten erhalten Sie die Gelegenheit es besser zu machen!
Bei der Entwicklung von Java ging es ziemlich rasant zu und her, und man suchte nach einer Möglichkeit, eine aktuelle Dokumentation zur Verfügung zu stellen. Bücher wären veraltet gewesen, bevor sie überhaupt in Druck gingen. Also hat man sich entschlossen ein Werkzeug zu programmieren, mit dem es möglich ist, direkt vom Quellcode aus, Web-Seiten im HTML-Format zu extrahieren. Das Werkzeug, javadoc, kann auch Ihnen gute Dienste erweisen, wenn Sie Ihre Java-Programme dokumentieren wollen. javadoc funktioniert auf einem simplen Prinzip: spezielle Kommentare werden mit den dazugehörigen Deklarationen in die HTML-Datei übernommen.
Durch die automatische Extraktion kann eine hohe Übereinstimmung von Dokumentation und Quellcode/Programm erreicht werden. Da die so generierten Dokumentationen im HTML-Format mit jedem Web-Browser angesehen werden können, ist es nicht nötig eine neue Software zu beherrschen. Ein einheitliches Layout hilft darüber hinaus auch beim Navigieren zwischen den Klassen, Feldern und Methoden. Was hier so herrlich klingt, dass man eigentlich kaum warten kann mit der Dokumentation loszulegen, hat auch einige Hacken. Sie werden sie (leider) noch kennenlernen.
Ein Ziel haben Sie sicher schon erreicht, nämlich die Verwendung von und das Navigieren in Java-Dokumentationen. Wenn Sie diesen Posten bearbeitet haben, sollten Sie zusätzlich:
Dokumentieren Sie mit javadoc Ihre Arbeit in dieser Werkstatt. Sie setzten selbst die Kriterien zur Beurteilung Ihrer Dokumenation fest.
Es stehen Ihnen folgende Materialien zur Verfügung:
OOP - Werkzeuge - Referenzen - Fäden - Synchronisation - Applets - Dokumentation
Werkstatt - Bibliographie