Integrierte Dokumentation für Software-Module

Abstract

Ein umfangreiches und komplexes Software-System muss in mehrere Module unterteilt werden, damit dieses verständlich bleibt. Dabei hilft eine Moduldokumentation, welche die Details eines einzelnen Moduls beschreibt. Existierende Werkzeuge zur integrierten Software-Dokumentation unterstützen die Dokumentation auf Modulebene nur unzureichend. So wird oftmals keine Integration in gängige Entwicklungsumgebungen geboten oder die Dokumentation eines Moduls wird zusammen mit der Dokumentation von Klassen und Methoden vermischt. Ziel dieser Diplomarbeit war es daher J-PaD, ein Werkzeug zur integrierten Dokumentation von Software-Modulen, zu entwickeln. Es erlaubt eine Dokumentation von Java-Paketen über eine flexibel anpassbare, grafische Oberfläche. J-PaD wurde als Plugin für die Entwicklungsumgebung Eclipse konzipiert, wodurch Entwickler dieses Werkzeug in einer gewohnten Umgebung verwenden können. Die Dokumentation eines Moduls wird dabei in einer separaten Datei gespeichert, welche sich jedoch in direkter Nähe zum Code befindet.