Download (5Mb) - oops/ - Oldenburger Online-Publikations-Server

91
7 Umsetzung des Prototyps
In diesem Kapitel wird vorgestellt, wie die Umsetzung der beschriebenen Konzepte in Form eines
Prototyps realisiert ist. Die entstehende Softwarelösung bzw. der Prototyp setzt sich aus den zwei
genannten Teilen zusammen, dem Backend sowie dem Frontend, auf welche in diesem Kapitel näher
eingegangen wird. Als Erstes wird aber ein kurzer Überblick über das Konzept “Quelltextqualität”
gegeben.
7.1 Allgemeine Merkmale der Quelltextqualität
Unter Berücksichtigung der Merkmale der Quelltextqualität wurde bei der Entwicklung der Softwarelösung
darauf geachtet, dass die folgenden allgemeinen Prinzipien der Qualität durchgehend
eingesetzt wurden:
• Dokumentation: Die Dokumentation wurde mithilfe von Javadoc 1 im Fall des Frontends sowie
ein Javadoc-ähnliches System namens YARD 2 im Fall des Backends erstellt. Dokumentiert wurden
Klassen, einzelne Methoden sowie weitere erklärungsbedürftige Attribute bzw. Felder der
Klassen. Die Verwendung von Javadoc und Javadoc-ähnlichen Dokumentationswerkzeugen verschafft
den Vorteil, dass die Vorgänge zur Erstellung von statischen Webseiten, die die Softwarelösung
anhand der eingebetteten Dokumentationstexte vorstellt, automatisiert sind. Darüber hinaus
wird versucht, Kodeblöcke mit eigenen Erklärungen in Form von ein- oder mehrzeiligen Kommentaren
zu versehen. Dies dient zur Erhebung der Lesbarkeit und allgemeinen Verständlichkeit
der benutzten Programmiertechniken.
• Logging: Zusätzlich zu der Dokumentation wurde darauf geachtet, sämtliche Logging-Ereignisse
so häufig wie möglich zu verwenden. Durch die Bezeichnung “Logging” wird die Dokumentation
von Ereignissen rund um das entwickelnde System zusammengefasst. Diese Mitteilungen lassen
sich verschiedenen Warnungsstufen zuordnen und können in mehreren Formaten exportiert werden.
Ein häufiger Anwendungsfall von Logging ist die Ausgabe eintretender, meist unerwarteter
System- sowie Werkzeug-Fehlermeldungen und -Ereignisse. Diese Ausgaben müssen im Hintergrund
behandelt bzw. gelagert werden, sodass der Nutzer nicht beeinträchtigt oder verwirrt wird.
Die verwendeten Logging-Werkzeuge sind im Fall des Frontends mit der Android-Plattform mitgeliefert,
während im Fall des Backends wurde das Werkzeug namens “Log4r” (eine Umsetzung
der Log4j Konzepten aus der Java-Welt in Ruby) umgesetzt und bzw. erweitert wurde.
• Behaviour-Driven Development (BDD 3 ): Im Fall des Backends wurden Prinzipien rund um die
verhaltensgetriebene Softwareentwicklung eingesetzt. Bei der Verwendung der verhaltensgetriebenen
Softwareentwicklung wird geprüft, ob die Ziele (z.B. die Anforderungen) des Softwareprodukts
erreicht werden können. Zu diesem Zweck wird eine Spezifikation (engl. specification,
Kurzform “spec”) erstellt, in der das erwartete Verhalten des Quelltextes kurz beschrieben wird. In
ihrer rein textuellen Form beschreibt eine Spezifikation das Verhalten mithilfe von “Vorausgesetzt
dass [...] erfüllt ist, beim Auftritt dieses Ereignisses muss dies folgendermaßen behandelt werden”
(engl. “Given – When – Then”) Sätzen. Hiermit können auch die Stakeholders mit bei
1 Ein in Java eingesetzt aber an weiteren Sprachen angelehntes Format für die textuelle Dokumentation vom Quelltext
2 YARD (Yay! A Ruby Documentation Tool), http://www.yardoc.org/
3 Einführung in BDD: http://dannorth.net/introducing-bdd/