Die COMPUTERWOCHE setzt in dieser Ausgabe die Serie zum Thema "Strukturierte Programmierung" fort. Dieser Beitrag stammt von Heinz Neubecke Leiter EDV-Organisation bei der IWKA Industrie-Werke Karlsruhe Augsburg Aktiengesellschaft Karlsruhe.
Teil III
5. Lesbarkeit
b) Namensvorsatz
Die zweite Version der eindeutigen Kennzeichnung besteht darin, vor jeden Datennamen eine Abkürzung zu stellen, die angibt, zu welcher Datei das Datenelement gehört. Hierzu sollte grundsätzlich der erste Buchstabe des in der File-Definition-Eintragung gewählten Dateinamens, verwendet werden.
Mögliche Abkürzungen sind:
E - Eingabe
A - Ausgabe
D - Drucker
Z - Zwischenfelder
RF - Rechenfelder
T - Tabellen
V - Vergleichsfelder
S - Schalter
Beispiel:
ANR Auftragsnummer
EANR Auftragsnummer in der Eingabedatei
DANR Auftragsnummer in der Druckdatei
5-5-2 Paragraphen- und Kapitelnamen
Für Paragraphen- und Kapitelnamen sollten Begriffe verwendet werden, die etwas über, die Funktion des Paragraphen oder Kapitels aussagen. Wo der Name nicht ausreicht, um die Funktionen eines Moduls zu erläutern, sollte ein entsprechender Kommentar (* in Spalte 7 - Erklärung siehe Unten) eingebaut werden. Dadurch wird die Lesbarkeit eines Programmes wesentlich erhöht.
5.6 Vermeidung von Literalen
Numerische Literale (außer 0 und 1) sollten wegen der nie ausgeschlossenen Möglichkeiten der Notwendigkeit späterer Änderungen vermieden werden; sie verschlechtern aber auch die Lesbarkeit von Programmen, da man einer numerischen Konstante nicht ansehen kann, welche Rolle sie spielt.
Man kann zum Beispiel der Zahl 80 nicht ansehen, ob sie die Anzahl der Spalten einer Lochkarte bedeutet oder etwa in einem kommerziellen Programm die Anzahl verschiedener Artikel, über deren Verkauf Buch geführt wird. Es ist hier besser, eine Variable mit einem gut gewählten Namen zu verwenden, deren Wert in Cobol durch VALUE auf 80 gesetzt wird.
5.7 Einrücken von Befehlsfolgen
Um den Zusammenhang von Programmbausteinen zu verdeutlichen, empfiehlt es sich, geschachtelte Befehlsfolgen im Programmtext einzurücken und Anweisungen gleicher Schachtelungstiefe direkt untereinander zu schreiben. Der erzielte Effekt ist natürlich rein optisch, er betrifft nur den Wert eines Programmes als Verständigungsmittel von Mensch zu Mensch, aber gerade das ist für, den Gebrauchswert und die Zukunftssicherheit eines Programmes wesentlich.
In Cobol sollte man alle Anweisungen des THEN- beziehungsweise ELSE-Teils einer IF-Anweisung einrücken (zum Beispiel um vier Stellen).
5.8 Verwendung von Kommentaren
Kommentare allein können ein Programm zwar nicht lesbar machen, sie können aber
die Lesbarkeit eines gut strukturierten Programms erheblich erhöhen.
In Cobol werden Kommentare am besten in getrennte Zeilen geschrieben, die in Spalte 7 einen * enthalten.
Diese Art Kommentare zu schreiben, ist dem NOTE-Verb vorzuziehen, weil sie in jedem Teil eines Programmes verwendet werden kann.
Kommentare können so außerdem viel leichter von den Programmanweisungen unterschieden werden.
Kommentare können dazu dienen, die Funktion einer Komponente zu erklären oder die Arbeitsweise schwer verständlicher Befehlsfolgen klarzumachen. Kommentare sind sehr wichtig, auch in der DATA DIVISION. Sie sind die einzige Möglichkeit, in Cobol die Verwendung von Datenbereichen und ihre erlaubten Werte zu beschreiben.
Der Programmierer trägt die Verantwortung, daß der Inhalt der Kommentare mit dem aktuellen Stand von Programmanweisungen übereinstimmt. Bei Programmänderungen müssen auch die Kommentare überprüft werden.
Vorteilhaft für die Lesbarkeit eines Programms ist auch die rein optische Trennung von Paragraphen oder Kapiteln.
9. Zusammenfassung
In der strukturierten Programmierung tritt der Benutzer des Programms in den Mittelpunkt. Programme werden als Werkzeuge für Menschen geschrieben, um eine bestimmte Aufgabe zu erfüllen. In einem Bericht von F.T. Baker über die Erfahrungen mit der strukturierten Programmierung wird die Steigerung der Produktivität gegenüber früheren Praktiken auf das Doppelte geschätzt. Besonders wird die Steigerung der Zuverlässigkeit und der Änderbarkeit der Programme hervorgehoben.