Verbesserung eines Dokumentationswerkzeugs für Java-Pakete

Abstract

Java-Anwendungen werden in Module, im Java-Kontext "Pakete" genannt, unterteilt. Dabei war es allerdings bislang eher umständlich Module einzeln zu dokumentieren. Aus diesem Grund wurde in einer Diplomarbeit das Werkzeug J-PaD - Java Package Documenter - entwickelt, welches direkt in der Entwicklungsumgebung Eclipse integriert ist. Es ermöglicht die gezielte integrierte Dokumentation von Java-Paketen in einer anpassbaren Benutzeroberfläche mit Hilfe eines Plugin-Systems für die darzustellenden Eingabefelder.

In dieser Bachelorarbeit wird die Software J-PaD zunächst sowohl auf vorhandene Mängel als auch auf Möglichkeiten für Erweiterungen untersucht. Hierfür wird ein brauchbares Vorgehen entwickelt, um möglichst viele Schwachstellen aufdecken zu können. Um die entstehende Befundliste zu priorisieren, wird auch ein Bewertungsschema definiert, welches die Befunde auf verschiedene Arten ordnet.

Aufbauend auf der priorisierten Befundliste werden dann konkrete Verbesserungen ausgesucht, deren Umsetzung im Kontext möglich und sinnvoll erscheint. Diese Verbesserungen und Erweiterungen werden dann an J-PaD umgesetzt und die entstehenden Änderungen dokumentiert.

Java applications are divided in modules. These modules are called "packages" in Java. Although it was rather cumbersome to document the modules one by one so far. For this reason the tool J-PaD - Java Package Documenter - was developed in a diploma thesis. J-PaD is directly integrated in the development environment Eclipse and allows for the systematic integrated documentation of Java packages in a flexible user interface with the help of a plugin system for the input fields to be displayed. In this bachelor thesis the software J-PaD initially is analyzed both for existing defects and for possibilities for extensions. For this purpose a suitable procedure is developed in order to be able to expose as much flaws as possible. In order to prioritize the emerging list of findings an assessment scheme is defined which sorts the findings in different ways. Based on the prioritized list of findings concrete improvements are chosen so that their realization seems possible and reasonable. These improvements and extensions for J-PaD are then implemented and the resulting changes are documented.