Prof. Dr. Pape - Java Programmierrichtlinien - Quelltextformatierung

Deutsch

Quelltextformatierung - Allgemeines

Zurück zur Übersicht

Programmierstile

Regel: Mische in einer Klasse nie verschiedene Programmierstile.
Regel: Bei bestehenden Quelltexten gilt insbesondere, dass der bestehende Programmierstil übernommen oder überall in der Klasse geändert wird.
Begründung: Quelltexte werden dadurch für alle lesbarer.

Beispiel

if (a > 0)
  {
  a = a + 1;
  // Klammer sind immer auf neue Zeile
  // und mit den Anweisungen eingerückt
  }

Dieser Klammerungsstil mit Einrückung der geschweiften Klammern ist eher selten anzutreffen. Falls eine derartige Klasse im Quelltexte geändert oder ergänzt wird, sollte man die Klammer in dieser Klasse immer in der gleichen Art und Weise setzen.

Begründung

Werden in einer Klasse verschiedene Stile verwendet, so ist der resultierende Quelltext schwerer verständlich. Man stelle sich einen deutschen Text vor, In Dem Die gross- Und Kleinschreibung bunt durcheinander gewürfelt wird. OderaufLeerzeichen zwischen Wörternmalverzichtetwird und dAnn wIeder mAl nIcht. Der Leser muss sich dadurch andauernd mühsam umstellen.

Diese Regel gilt natürlich nur für die Codeteile, in der ein Stil erkennbar ist: nur weil zum Beispiel mal Leerzeichen vor und nach den Operatoren gesetzt werden und dann mal wieder nicht – es also keinen erkennbaren Programmierstil gibt – heißt das natürlich nicht, dass man das genauso machen soll. In diesem Fall sollte man seinen eigenen Stil für Operatoren folgen und besser noch den Rest des Quelltextes entsprechend verbessern, auch wenn dieser von jemand anderem implementiert wurde.

Allgemeine Regeln

Regel: Schreibe nie Zeilen mit mehr als 80 Zeichen.
Regel: Stelle den Editor so ein, dass er diese Grenze als vertikale Linie klar darstellt.
Begründung: Quelltexte werden dadurch lesbarer.

Begründung

Die 80 Zeichengrenze hat historischen Gründe: frühe Terminals hatten max. 80 Zeichen pro Zeile. Heutzutage ist die Grenze je nach Bildschirmauflösung und Font etwas größer. Grundsätzlich sollte man aber nicht von einer zu hohen Anzahl Zeichen pro Zeile ausgehen. Überlange Zeilen sind für Menschen schlecht lesbar, da nur eine begrenzte Anzahl von „Wörtern“ (ca. 5-7) mühelos erfasst werden können ohne dass man das Gefühl bekommt angestrengt zu lesen. Des Weiteren ist das horizontale Scrollen bei überlangen Zeilen im Fenster im Gegensatz zum vertikalen mühsam, da bei Sprung auf die nächste Zeile, insgesamt der Quelltext sich sprunghaft nach links verschiebt (zu starker Kontextwechsel).