Kapitel 26 Style-Guide

Kunst ist eine Lüge,
die uns die Wahrheit begreifen lässt.
– Pablo Picasso

26.1 Programmierrichtlinien

Es ist immer ein Problem für einen selbst, aber noch mehr in der Gruppe, Programme konsistent zu schreiben. Eine Möglichkeit sind Richtlinien, die Hinweise geben, wie Programme korrekt zu schreiben und leicht zu warten sind. Um dieses zu erreichen, sollte der Quellcode verschiedene Kriterien erfüllen. Er sollte

eine konsistente Formatierung haben

leicht zu warten sein

einfach zu lesen und zu verstehen sein

frei von typischen Fehlern sein

Seit längerer Zeit gibt es Programmierrichtlinien, die genormte Quelltexte hervorbringen sollen, sodass diese auch von anderen Entwicklern nachvollzogen werden können. Unter Programmierrichtlinien fällt nun Verschiedenes: Namensgebung von Variablen, Methoden und Klassen, Einrückung des Programmcodes, Dokumentation und mehr. Wir wollen uns nun mit einigen Punkten näher beschäftigen.

Die Programme »lint« und »indent«, aber auch »CodeCheck« werden von vielen genutzt, um Java-Programme systematisch auf Portabilitätsaspekte, softwaremetrische Aspekte oder Wartungsfähigkeit zu prüfen. Das Buch »Advanced Java: Idioms, Pitfalls, Styles and Programming Tips«¹  beschäftigt sich ebenfalls mit dieser Thematik.

¹   Chris Laffra, Prentice Hall, 288 Seiten, ISBN 0135343488.