Projektgruppe Visual Analytics - Medieninformatik und Multimedia ...

204 Kapitel 12 Qualitätssicherung
„Completed source code should reflect a harmonized style, as if a single
developer wrote the code in one session.“ ([Micg])
Die Richtlinien sind dabei nicht als unumstößliche Regeln zu sehen. Im Einzelnen kann
es sinnvoll sein, gezielt die vorher festgelegten Regeln zu verletzen. Dieses ist dann mit
Hilfe von Kommentaren zu begründen. Im Allgemeinen können die Coderichtlinien in
folgende Bereiche gegliedert werden:
• Dateinamen und Verzeichnisstrukturen
• Namenskonvention
• Formatierung des Codes
• Kommentare
• Programmierpraktiken
Meistens ist es sinnvoll, zunächst allgemeine Regeln festzulegen, die sich über die
verschiedensten Bereiche ausdehnen.
Globale Regeln
In der Projektgruppe ist festgelegt worden, dass Codevariablen komplett in Englisch zu
schreiben sind. Dass heißt, die Klassennamen, Variablennamen, Methodennamen und
die Kommentare sind in Englisch zu halten. Als softwareseitige Unterstützung zur Code
Analyse wird die in Microsoft Visual Studio Team Suite 2008 integrierte Code Analyse
verwendet. Des Weiteren sind folgende allgemeine Richtlinien festgelegt, die teilweise
softwareseitig nicht überprüft werden können (vgl. [Krü03, HD05, Edm09]):
• Code wird so einfach wie möglich gehalten, da er von anderen gelesen werden
muss.
• Klassen werden so einfach wie möglich gehalten. Anstelle von großen monolithischen
Klassen wird der Code auf mehrere kleine verteilt, wodurch die
Übersichtlichkeit erhöht wird. Des Weiteren wird hierdurch der objektorientierte
Gedanke unterstützt. Es ist nicht notwendig, jede einzelne Klasse in eine eigene
Datei auszulagern. Zusammenhängende Klassen sollten, wenn möglich, in einer
Oberdatei zusammengefasst werden.
• Noch unvollständige Funktionen einer Klasse oder Methode werden mit // TODO:
kommentiert.