2.1.1. Lesbarkeit von Programmen

Schon bei der leeren Klasse ist eine der wichtigsten Aspekte der Entwicklung von Programmen mit hoher Qualität zur Sprache gekommen. Das Prinzip heißt:

Programme zu schreiben ist leicht.
Programme zu lesen ist schwer.

Ein beträchtlicher Anteil des Softwareentwicklungsaufwands wird in das Lesen und Verstehen Programme Anderer investiert. Das Schreiben lesbarer Programme reduziert daher die Kosten der nachkommenden Generation enorm. Hier gelten folgende Empfehlungen.

1. Die Wahl der Programmiersprache

Ältere Programmiersprachen sind für das Schreiben gut lesbarer Programme weniger geeignet als modernere. Hier liegt Java gut im Rennen, wenn auch andere Sprachen wie Ada oder Eiffel mehr Gewicht auf Lesbarkeit legen.

2. Die Wahl der Bezeichner

Mit einem gut gewählten Bezeichner (wie z.B. LeeresProgramm) assoziiert den Leser genau mit der Idee, die der Programmierers im Moment der Wahl des Bezeichners im Kopf hat. Er soll weder zu kurz noch zu lang (ca. 10 Zeichen) sein. Kryptische (I2346XYb6 ) und "mnemotechnische" (BZ) Bezeichner sind ungeeignet.

3. Geeignete Kommentare

Kommentare dienen dazu, dem Leser des Programms das Erfassen seines Sinnes zu erleichtern. Ein gutes Programm enthält weder zu wenig noch zu viel Kommentare; der Umfang dürfte etwa dem Umfang des sonstiges Programms gleich sein. Wichtig ist beim Schreiben von Kommentaren die Zielgruppe vor Augen zu halten: Programmierer, die die Sprache und die Aufgabe kennt, nicht aber die Details des Programms.

4. Strukturierung (mit Einrückung) vom Programmtext

Der Programmtext soll nach einer geeigneter Konvention strukturiert werden. Dies beinhaltet die konsequente Verwendung von Zeilenwechsel (mit nicht zu langen Zeilen und einer Anweisung pro Zeile), Tabulatoren (für Einrückung), Leerzeichen und Leerzeilen. Insbesondere die Einrückung soll die Anfertigung von Struktogrammen überflüssig machen.