Programmierrichtlinien

Das Problem

Es sind schon Teams fast auseinander geflogen, weil darüber diskutiert wurde, wo denn geschweifte Klammern hingesetzt oder wie Attributbezeichner geschrieben werden sollen.

Andererseits ist anerkannt, daß die Verwendung von einheitlichen Programmierrichtlinien die Arbeit am Sourcecode vereinfacht. Die richtige Balance zu finden ist nicht einfach, aber notwendig.

Die Lösung

Als eine der 12 Arbeitsmethoden beinhaltet XP Richtlinien, die den Programmierern vorgeben,

• wie Code angeordnet wird,
• wie Dateien im Dateisystem angeordnet werden sollen,
• wie die Einstellung für den Übersetzer (Compiler) und Binder (Linker) sein sollen.
• wie die Bezeichner für Dateien, Klassen, Methoden, Attribute, Parameter, und lokale Variablen sein sollen.

Für Java liegt eine solche Spezifikation vor. Für andere Programmiersprachen kann diese angepaßt werden.

Die mittlerweile verfügbaren Entwicklungsumgebungen wie z.B. IntelliJ oder auch Visual Studio.NET bieten die Möglichkeit mehr (IntelliJ) oder weniger (VisualStudio) Einfluß zu nehmen auf die Formatierung von Quelltext. So kann eingestellt werden, ob die öffnende geschweifte Klammer noch auf die gleiche Zeile wie das zugehörige Konstrukt oder auf die nächste Zeile gesetzt werden soll. Ein anderes Beispiel für die Einstellmöglichkeiten ist die Option, ob Tabs durch Leerzeichen ersetzt werden sollen.

Diese Kleinigkeiten mögen sich fast lachhaft anhören. Einfache Lesbarkeit ist jedoch von essentieller Bedeutung für das paarweise Arbeiten im Team. Nur wenn sämtlicher Quelltext nach den gleichen Richtlinien erzeugt wurde, wird eine optimale Lesbarkeit erreicht und damit die Produktivität gesteigert.

Tipps

• Programmierrichtlinien sollten immer im Team verabschiedet und nicht von außen vorgegeben werden.
• Programmierrichtlinien regelmäßig überprüfen.
• Programmierrichtlinien nicht gegen gängige Standards machen, z.B. für Java.
• Programmierrichtlinien nicht gegen die Entwicklungsumgebung (IDE) durchdrücken.
• Bei der Auswahl von Editoren darauf achten, dass diese die gewünschte Formatierung ermöglichen.