AnaDoc - Integration von Programmanalyse und Dokumentation

von Michael Stiller, 2003

Mit dem Werkzeug javadoc kann man aus speziellen Kommentaren im Java-Quellcode einfach und schnell übersichtliche Dokumentation im HTML-Format erzeugen. Diese Dokumentation beschreibt alle Klassen, Methoden und Parameter im Detail, enthält Querverweise und bietet einen alphabetischen Index. Jedoch hilft einem diese Art der Dokumentation nicht, wenn man einen Überblick über ein größeres Stück fremde Software bekommen möchte. Das Problem besteht darin, in dem Wust von Klassen und trivialen set- und get-Methoden, diejenigen Programmteile zu finden, die die eigentliche Arbeit leisten.

Glücklicherweise ist vorgesehen, dass man den Inhalt und das Aussehen der von javadoc erzeugten Dokumentation über selbstgeschriebene Klassen (ein sogenanntes Doclet) verändern kann. Ausserdem verfügen wir über einen flexiblen Baukasten von Programmanalysen, die z.B. einfache von komplexen Methoden unterscheiden können und die Struktur einer Methode überblicksartig grafisch darstellen können.

Ziel dieser Studienarbeit war es, ein neues Doclet für javadoc zu schreiben, das HTML-Dokumentation mit zusätzlichen Verständnishilfen erzeugt. Dazu stösst das Doclet ausgewählte Programmanalysen an und baut die grafischen bzw. textuellen Analyseergebnisse mit in die Dokumentation ein. Als weitere Verbesserung sollte das neue Doclet Verweise auf die Dokumentation zu anderen, unabhängig entwickelten Programmteilen und Biliotheken (fast) automatisch unterstützen.

Genauere Informationen finden Sie in der Ausarbeitung.