Erfassung von Anforderungen an Software-Module

Abstract

In modernen Programmiersprachen werden Übersetzungseinheiten in Module zusammengefasst. Um Module dabei besser dokumentieren zu können, wurde das Werkzeug J-PaD entwickelt, das erweiterte Möglichkeiten für die integrierte Dokumentation auf Modulebene bietet. Der Einarbeitungsaufwand in J-PaD bei bestehenden Softwareprojekten ist momentan allerdings hoch, weil viele Informationen in das Werkzeug nachgetragen werden müssen. Viele der benötigten Informationen befinden sich jedoch bereits an anderen Stellen im Projekt wieder, wie etwa im Versionsverwaltungssystem.

In dieser Arbeit wird darum analysiert, wie sich die in einem Softwareprojekt anfallenden Daten verwenden lassen, um die in J-PaD verwaltete Modulbeschreibung automatisch ausfüllen zu können. Es wird untersucht, wo sich die benötigten Daten befinden und wie diese verarbeitet werden müssen. Anschließend wird beschrieben, wie J-PaD um eine Importfunktion erweitert wird, die das automatische Ausfüllen durchführt. Zuletzt wird die Importfunktion an einem Open-Source-Projekt demonstriert. Die hierbei gemachten Beobachtungen werden vorgestellt und die Resultate werden bewertet.

In modern programming languages, compilation units are encapsulated in modules. To improve module documentation, the tool J-PaD has been developed, which gives enhanced capabilities for the integrated documentation one module-level. Unfortunately, the effort to use J-PaD in existing software projects is high at the moment, since a lot of information has to be added to the tool. However, a lot of information is already available in other places around the project, like in the version control system. Therefore, this thesis analyses how the data that is accumulated in software projects can be used to fill out the module description held in J-PaD automatically. It is examined where the required data can be found and how it has to be processed. Afterwards it is described how J-PaD is enhanced with an import function that does automatically fill out the module description. At the end, the import function is demonstrated on an open-source project. Observations made thereby are presented and the results are evaluated.