Formatierung

Damit fremder Programmtext leicht verstanden werden kann, ist es sehr hilfreich, wenn eine einheitliche Formatierung und Darstellung des Programmtextes verwendet wird. Dies hängt natürlich auch von den verwendeten Werkzeugen ab, da es nicht mehr überall üblich ist, Programmtext als ASCII-Text abzuspeichern. Insbesondere das Züricher Oberon-System weicht davon ab, und es ist dort möglich, Programmtext wie den Text eines Dokuments zu setzen (mit Zeichensätzen, Hervorhebungen, Schriftgrößen, Diagrammen und Farben).

Bei der Ulmer Oberon-Bibliothek gelten beispielsweise folgende Richtlinien:

• Programmtext wird eingerückt entsprechend der Blockstruktur von Oberon und entsprechend der Verschachtelung von Anweisungen, wobei eine Einrückweite von 3 Zeichen eingehalten wird. Beispiel:

        MODULE Hello;
  
           IMPORT Write;
  
           PROCEDURE DoHello;
           BEGIN
              Write.Line("Hallo!");
           END DoHello;
  
        BEGIN
           DoHello;
        END Hello.
  

• Zeilen sollten normalerweise nicht länger als 80 Zeichen lang sein. Wenn eine Zeile umgebrochen wird, werden Fortsetzungszeilen jeweils eingerückt. Typischerweise wird die Zeile nach einem Operator oder einem Komma getrennt.

• Leerzeichen gibt es grundsätzlich nach Satzzeichen (Komma oder Semikolon), jedoch nicht davor. Operatoren werden beidseitig von Leerzeichen umgeben, und bei Einklammerungen (bei Ausdrücken, Prozeduren, Indizierungen und Mengen) wird ansonsten auf Leerzeichen verzichtet. Beispiel:

        result := P(x, y + z * (17 - a[i]));
  

• Da Oberon nur wenige Vorrangstufen in seiner Ausdrucks-Grammatik besitzt, kann ohne Verlust an Klarheit auf überflüssige Klammern verzichtet werden.

• Ganz zu Beginn des Programmtextes kann ein Copyright-Vermerk und die Entwicklungshistorie in einem Kommentar vermerkt werden. Kommentare zu Gruppen von Prozeduren, Variablen oder Anweisungen stehen jeweils davor und werden nicht weiter eingerückt. Kommentare, die ein Modul oder eine Prozedur beschreiben, folgen jeweils dem Kopf und werden eingerückt. Kommentare zu einzelnen Konstanten, Variablen, Feldkomponenten und Anweisungen können nachfolgend auf der gleichen Zeile stehen oder bei mangelndem Platz eingerückt auf der nächsten Zeile folgen.