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.
Inhaltsverzeichnis
1 Einleitung
2 Grundlagen der Dokumentation von Softwareprogrammierung
2.1 Gründe für die Dokumentation von Softwareprogrammierung
2.2 Ziele der Dokumentation
2.3 Möglichkeiten der Dokumentation von Entwicklungsschritten
2.4 Problemfelder bei der Dokumentation
3 Angewandte Dokumentationsmöglichkeiten bei der Programmierung von CASSAC
3.1 Grundlagen zu Javadoc
3.2 Anwendungsmöglichkeiten von Javadoc beim Programmieren von CASSAC
3.3 Bisherige Umsetzung bei der Programmierung von CASSAC
4 Bewertung der Situation und Optimierungsmöglichkeiten im Projekt CASSAC
4.1 Bewertung des Status quo und Optimierungsvorschläge
4.2 Konkretisierung der Verbesserungsvorschläge
4.3 Realisierbarkeit der genannten Optimierungsmöglichkeiten
5 Fazit und Ausblick
Zielsetzung & Themen
Diese Arbeit reflektiert die Praxis der Softwaredokumentation im studentischen Projekt CASSAC (Course And Space Scheduled Allocation Controlling), mit dem primären Ziel, den Status quo der Dokumentationsqualität zu bewerten und konkrete Optimierungspotenziale aufzuzeigen, um die Wartbarkeit und Einarbeitung neuer Mitglieder zu verbessern.
- Grundlagen der Software- und Quelldokumentation
- Einsatzmöglichkeiten des Tools Javadoc in Java-Projekten
- Analyse der bestehenden Dokumentationspraxis im Projekt CASSAC
- Entwicklung von Standards und Strategien zur Qualitätssicherung
Auszug aus dem Buch
3.1 Grundlagen zu Javadoc
Nachdem zuvor die Grundlagen der Softwaredokumentation behandelt wurden, beschäftigt sich der folgende Abschnitt mit dem Dokumentationswerkzeug Javadoc.
Javadoc ist ein Dokumentationswerkzeug, das in der Programmiersprache Java verwendet werden kann. Mit Hilfe von Javadoc können Quelltextkommentare automatisch in eine Dokumentationsdatei geschrieben werden. Diese Dokumentationsdatei ist ein HTML-Dokument, das alle relevanten Kommentare des Quelltextes übersichtlich festhält.
Die Kommentare innerhalb des Quelltextes werden so markiert, dass sie vom Kompilierer (engl. Compiler) nicht mitgelesen werden und demnach keinen Einfluss auf die abschließende Ausführung des Programms haben. Javadoc hingegen liest die Kommentare und wertet sie aus. Sie beschreiben beispielsweise, welche Funktionen und Aufgaben die verschiedenen Teile des Programmcodes haben oder wer der Autor des Quellcodes ist.
Die Java-API von Sun Microsystems wurde nach genau diesem Schema erstellt. Die Entwickler haben demnach ihre Quellcodes durch intelligente Kommentierungen von Javadoc zu einer recht großen HTML-Dokumentation machen lassen. Dieses Schema hat es ihnen ermöglicht, eine jederzeit aktuelle Dokumentation zur Verfügung zu haben. Hierfür müssen jedoch auch bestimmte Regeln und Standards bei der Programmierung bzw. Kommentierung des Quellcodes eingehalten werden.
Möchte der Entwickler einen für Javadoc lesbaren Kommentar schreiben, muss er ihn mit den Zeichen /** vor der ersten Zeile des Kommentars einleiten. Zum Beenden muss er wiederum */ unter oder hinter die letzte Zeile des Kommentars schreiben.
Zusammenfassung der Kapitel
1 Einleitung: Diese Einführung erläutert die Bedeutung der Qualitätssicherung bei der Softwareentwicklung und stellt die Zielsetzung der Arbeit im Kontext des Projekts CASSAC dar.
2 Grundlagen der Dokumentation von Softwareprogrammierung: Das Kapitel vermittelt theoretische Hintergründe zu den Beweggründen, Zielen und Problematiken, die bei der Dokumentation von Quellcode auftreten können.
3 Angewandte Dokumentationsmöglichkeiten bei der Programmierung von CASSAC: Hier wird das Werkzeug Javadoc theoretisch vorgestellt und seine spezifische Anwendung sowie die aktuelle Nutzung im Projekt CASSAC analysiert.
4 Bewertung der Situation und Optimierungsmöglichkeiten im Projekt CASSAC: Dieses Kapitel bewertet den bestehenden Dokumentationsstatus und entwickelt konkrete, realisierbare Verbesserungsvorschläge zur Standardisierung und Wissensvermittlung.
5 Fazit und Ausblick: Das Fazit fasst die zentralen Ergebnisse zusammen und unterstreicht die Notwendigkeit nachhaltiger Dokumentationspraktiken für zukünftige Projektgenerationen.
Schlüsselwörter
Softwaredokumentation, CASSAC, Qualitätssicherung, Javadoc, Java, Quellcode, Kommentierung, Standardisierung, Softwareentwicklung, Eclipse, Projektmanagement, Benutzerdokumentation, Wartbarkeit, Prozessoptimierung, Entwicklungsschritte
Häufig gestellte Fragen
Worum geht es in dieser Arbeit?
Die Arbeit befasst sich mit der Reflexion der Softwaredokumentation im studentischen Projekt CASSAC und untersucht, wie die Dokumentationsqualität durch den Einsatz von Tools wie Javadoc gesteigert werden kann.
Welche zentralen Themenfelder werden abgedeckt?
Zentrale Themen sind die Notwendigkeit von Software-Qualitätssicherung, Methoden der Kommentierung, Probleme bei der Einhaltung von Standards in Entwicklerteams sowie die Möglichkeiten zur Optimierung der Projektübergabe.
Was ist das primäre Ziel der Arbeit?
Ziel ist es, den Ist-Zustand der Dokumentation im Projekt CASSAC zu bewerten und praxistaugliche Empfehlungen zu formulieren, um die Softwareentwicklung effizienter und für neue Mitglieder verständlicher zu machen.
Welche wissenschaftliche Methode wird verwendet?
Der Autor stützt sich auf eine Literaturanalyse zu Software-Engineering-Standards sowie auf eine empirische Analyse des bestehenden Quellcodes und der internen Arbeitsprozesse im Projekt CASSAC.
Was wird im Hauptteil behandelt?
Im Hauptteil werden zunächst theoretische Grundlagen zur Dokumentation geklärt, das Werkzeug Javadoc im Detail erläutert und anschließend die konkrete Situation im CASSAC-Projekt kritisch hinterfragt und optimiert.
Welche Schlüsselwörter charakterisieren die Arbeit?
Wichtige Begriffe sind Softwaredokumentation, CASSAC, Javadoc, Quellcode-Qualität, Standardisierung und Qualitätssicherung.
Warum ist eine Standardisierung der Kommentare in CASSAC so wichtig?
Eine Standardisierung ist essenziell, da CASSAC von wechselnden studentischen Entwicklern programmiert wird. Einheitliche Standards erleichtern neuen Entwicklern den Einstieg und verbessern die allgemeine Wartbarkeit des Codes.
Welchen Einfluss hat Eclipse auf die Dokumentation in diesem Projekt?
Eclipse unterstützt als integrierte Entwicklungsumgebung (IDE) den Entwickler durch hilfreiche Funktionen, mit denen Javadoc-Kommentare effizient erstellt und automatisch in HTML-Dokumentationen umgewandelt werden können.
- Citation du texte
- Marcel Liedke (Auteur), 2010, Softwaredokumentation im Projekt CASSAC, Munich, GRIN Verlag, https://www.grin.com/document/166327
