Pflichtenheft von byteme - PI - Praktische Informatik

7.3. UMSETZUNG IM PROJEKT 65
7.3.4.1 Code-Dokumentation
Die Quelltexte sollen auch von anderen Gruppenmitgliedern und zukünftigen Entwicklern
gut lesbar und verständlich sein. Darum werden alle wichtigen Variablen und Methoden
(JavaDoc-konform) direkt im Programmcode kurz erläutert. Bei komplexeren
Methoden wird in gleicher Weise auch auf Unterabschnitte bzw. Funktionsblöcke eingegangen.
7.3.4.2 Namensgebung
Für die Benennung von Klassen, Methoden und Variablen wird eine einheitliche Richtlinie
festgelegt. Zum Beispiel soll der Verwendungszweck einer Variable direkt anhand
des jeweiligen Bezeichners erkennbar sein. Diese Vorgehensweise erleichtert die Verständlichkeit
des Quelltexts. Insbesondere bei der Benennung von Methoden wird auf
eine klassenübergreifende Konsistenz geachtet, soweit dies möglich und sinnvoll ist.
Vor allem wird bei der Namesgebung darauf geachtet, die englische Sprache zu verwenden,
was vor allem in Bezug auf das spätere Open-Source-Dasein dieses Projektes
äußerst wichtig ist.
7.3.4.3 Programmierstandard
Die Umsetzung eines bestimmten Programmierstandards schließt bereits die Verwendung
von Namenskonventionen mit ein. Den Kern bildet jedoch ein Regelwerk das
festlegt, wie die syntaktischen Mittel der eingesetzten Programmiersprache verwendet
werden dürfen. Dies unterstützt zum einen die Erstellung von einheitlichem Code, hilft
aber auch dabei, Fehler zu vermeiden, die zum Beispiel beim Einsatz von bestimmten
Sprachmitteln auftreten können. Auch hier halten wir uns an den Java Style Guide 1 von
Sun.
7.3.5 Tests
Tests von Komponenten und Prototypen dienen der frühzeitigen Fehlererkennung. Je
später ein Programmfehler entdeckt wird, desto aufwendiger wird seine Behebung. Daher
wird bei der Implementierung auf die regelmäßige Anwendung von Tests geachtet.
Wir verwenden beim Testen sowohl automatische Unit-Tests als auch manuelle Tests.
7.3.5.1 Unit-Tests
Die sogenannten Unittests, die im XP eine elementare Rolle einnehmen (siehe Abschnitt
6.2.2), werden mit Hilfe von JUnit 2 durchgeführt. JUnit ist ein kleines, mächtiges
Java-Framework zum Schreiben und Ausführen automatischer Unit-Tests. Hierbei
werden Programmeinheiten in Isolation von anderen im Zusammenhang des Programms
benötigten Einheiten getestet. Die Größe der unabhängig getesteten Einheit
kann dabei von einzelnen Methoden über Klassen bis hin zu Komponenten reichen.
Hierbei wird, soweit dies möglich ist, auf Test First Programming gesetzt, bei dem
zunächst der Test und dann die Einheit programmiert wird.
1 http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
2 http://www.junit.org