16. Formatierung

Themen: Warum ist Code-Formatierung wichtig?; Vertikale Formatierung; Horizontale Formatierung; Konsistenz: Konventionen und automatische Codeformatierung
Folien: PDF
Glossar: PDF

Zentrale Aspekte

Codeformatierung ist zu wichtig, um sie zu ignorieren –
oder sie dogmatisch zu behandeln.
Formatierung offenbart die Sorgfalt und Professionalität,
die ein Programmierer in seine Arbeit investiert hat.
Formatierung erhöht die Les- und Wartbarkeit von Code.
Die investierte Disziplin überlebt den eigentlichen Inhalt.
Zusammenhänge und getrennte Konzepte sollten sich in
horizontaler und vertikaler Formatierung widerspiegeln.
Konsistenz ist wichtiger als der konkrete Inhalt.
Regeln sollten vom ganzen Team akzeptiert werden.

Fragen zur Vertiefung und Wiederholung

Diese Fragen dienen der persönlichen Beschäftigung mit der Thematik, werden aber nicht separat in der Vorlesung besprochen.

Warum ist Codeformatierung so wichtig?
Was ist entscheidend bei Konventionen für die Codeformatierung? Wie lässt sich die Umsetzung am Ehesten erreichen?

Weiterführende Literatur

Eine kommentierte und handverlesene Liste mit weiterführender Literatur zum Thema. Die Auswahl ist zwangsläufig subjektiv.

Die Ausführungen folgen in weiten Teilen jenen in {[martin-rc-2008]}, Kapitel 5. Weitere hilfreiche Erläuterungen zur Formatierung von Quellcode finden sich in Kapitel 31 in {[mcconnell-s-2004]} und, wenn auch eher versteckt, in Kapitel 1 in {[kernighan-bw-1999]}.

Eine knappe Einführung in Idiome in Programmiersprachen in Abgrenzung zu Entwurfsmustern (design patterns, vgl. Lektion 17) findet sich in Kapitel 4 in {[buschmann-f-1996]}.

Ein unabhängig von der eingesetzten Programmiersprache durchaus lesenswerter Gestaltungsleitfaden (style guide) für Quellcode ist das Python Enhancement Proposal 8 (PEP 8), grafisch aufbereitet von Kenneth Reitz.