I

Inhaltsverzeichnis

Abk  ürzungsverzeichnis.  II

Tabellenverzeichnis.   III

Abbildungsverzeichnis.   IV

1  Einleitung  1

2  Grundlagen der Dokumentation von Softwareprogrammierung.  2

2.1  Gründe für die Dokumentation von Softwareprogrammierung  2

2.2  Ziele der Dokumentation  3

2.3  Möglichkeiten der Dokumentation von Entwicklungsschritten.  3

2.4  Problemfelder bei der Dokumentation.  4

3  Angewandte Dokumentationsmöglichkeiten bei der  

Programmierung  von CASSAC.  6

3.1  Grundlagen zu Javadoc  6

3.2  Anwendungsmöglichkeiten von Javadoc beim Programmieren von  

CASSAC   8

3.3  Bisherige Umsetzung bei der Programmierung von CASSAC  9

4  Bewertung der Situation und Optimierungsmöglichkeiten im  

Projekt  CASSAC.  12

4.1  Bewertung des Status quo und Optimierungsvorschläge.  12

4.2  Konkretisierung der Verbesserungsvorschläge.  14

4.3  Realisierbarkeit der genannten Optimierungsmöglichkeiten  15

5  Fazit und Ausblick.  16

Literaturverzeichnis.   17

Marcel  Liedke  

Abkürzungsverzeichnis API Application Programming Interface

CASSAC Course And Space Scheduled Allocation Controlling

HTML Hypertext Markup Language

IDE Integrated development environment

Javadoc Java-Dokumentationswerkzeug

Pro bono Zum Wohle der Öffentlichkeit

QS Qualitätssicherung

Wiki Content-Management System

Marcel Liedke

Tabellenverzeichnis Seite

Tabelle 1: Javadoc-Optionen .................................................................................. 7

Marcel Liedke

Abbildungsverzeichnis Seite

Abbildung 1: Auszug aus dem Quellcode der Log-Klasse von CASSAC................ 9

Abbildung 2: HTML-Dokumentation einer Java Datei. .......................................... 11

Marcel Liedke

1 Einleitung

Die Qualitätssicherung (QS) stellt im Rahmen des Entwicklungsprozesses einer Software einen eminent wichtigen Faktor dar. Das liegt vor allem daran, dass fast jede Softwareentwicklung im Interesse eines Kunden stattfindet. Dieser ist meistens Geldgeber des Projektes und möchte natürlich, dass sein Geld auch seinen Interessen und Ansprüchen entsprechend eingesetzt wird. Deshalb stehen die Qualität der Software und die Zufriedenheit des Kunden in einem direkten Zusammenhang. Wirtschaftlich orientierte Unternehmen müssen aus diesem Grund ein unmittelbares Interesse an hoher Qualität ihrer Produkte besitzen, wenn sie langfristig wirtschaftlich lebensfähig sein wollen. Dementsprechend muss im Entwicklungszyklus einer Software ein hoher Aufwand in die QS investiert werden.

Die Programmierung von Software stellt einen sehr wichtigen, aber auch äußerst komplexen Faktor bei der Entwicklung eines neuen Softwareproduktes dar. Diese Hausarbeit befasst sich mit der Dokumentation der Softwareprogrammierung, die einen wichtigen Teil zur Sicherung der Qualität einer Software beiträgt. Da im von Studenten der Leibniz-Akademie Hannover durchgeführten, Projekt „Course And Space Scheduled Allocation Controlling” (CASSAC) die Programmiersprache Java verwendet wird, liegt der Fokus dieser Hausarbeit auf der Dokumentation der Programmierung von Java-basierter Software.

Das zweite Kapitel dieser Praxisreflexion befasst sich erst einmal mit den Grundlagen der Softwaredokumentation. Hierbei wird speziell auf die Gründe, Ziele, Möglichkeiten und Problemfelder, die die Softwaredokumentation mitbringt, eingegangen. Im dritten Kapitel geht es anschließend darum, das im Projekt CASSAC verwendete Java-Dokumentationswerkzeug Javadoc zu erläutern. Außerdem wird beschrieben inwieweit es im genannten Projekt bisher angewandt wurde.

Die zuvor festgestellte Situation wird dann im viertel Kapitel bewertet. Des Weiteren werden mögliche Verbesserungsoptionen genannt und hinsichtlich ihrer Realisierbarkeit in CASSAC untersucht. Abschließend folgen im Schlussteil dieser Arbeit ein Fazit und ein Ausblick hinsichtlich künftiger Entwicklungen der behandelten Thematik.

Marcel Liedke