Direkt zur Navigation | Direkt zum Inhalt



Clean Code mit Hilfe der Pfadfinder-Regel

Clean Code mit Hilfe der Pfadfinder-Regel

Die Pfadfinder-Regel

Nach unserem Vortrag „Die Kunst des Software Design“ auf dem PHP World Kongress, diskutierten Stephan und ich noch eine Weile darüber, wie man eine bestehende Anwendung im laufenden Betrieb am besten aufräumt. Ist eine Anwendung lang genug in Betrieb und groß genug, kommt oft der Ruf nach einem groß angelegten Refactoring-Projekt. Ein Projekt, in dem Entwickler endlich einmal die Zeit haben Dinge, die schon seit langer Zeit im Argen liegen, aufzuräumen und die Anwendung wieder in Ordnung zu bringen. In den wenigsten Fällen werden solche Projekte allerdings genehmigt oder entsprechend priorisiert.

Robert C. Martin schreibt in seinem Buch Clean Code, dass Code über die gesamte Lebensdauer „sauber“ gehalten werden muss und findet dafür eine treffende Regel der amerikanischen Pfadfinder: „Leave the campground cleaner than you found it“. Der einzelne Schritt beim Aufräumen muss dabei gar nicht groß sein. Ob eine lange Methode aufgebrochen, eine Duplikation eliminiert oder der Name einer Variable in einen ausdrucksvolleren Namen geändert wird, spielt dabei keine Rolle. Wenn der Code einer Anwendung mit jedem Commit ein kleines Stück sauberer wird, als er es zuvor war, wird die gesamte Anwendung nicht verrotten (siehe auch Broken-Window-Theorie).

Letztendlich sind wir zu dem Entschluss gekommen, dass in dem für gewöhnlich hektischen Alltag der Weg von Robert C. Martin genau der Richtige ist. Der Fokus bei der Entwicklung liegt allerdings eher auf einem konkreten TODO, anstatt auf dem Aufräumen der Codebasis. Probleme im Code werden zwar oft erkannt, aber nie korrigiert, da man gerade an etwas anderem dran ist. Aus diesem Grund wollten wir ein Poster gestalten, das einige kleine „Aufräum-Arbeiten“ auflistet und dazu ermuntert in kleinen Schritten das große Ziel zu erreichen. Nachdem Stephan bereits die Punkte gesammelt hatte, habe ich heute das Poster fertig gestellt. Ich bin gespannt, wie es ankommt und zu welchem Ergebnis es führen wird.

Die Pfadfinder-Regel als A4 Poster als JPEG zum Download (ca. 1.1 MB)

Kommentare

Frank
Montag, 18.01.2010 (0:41)

Gibt’s das Bild auch in größer? :-)

Stephan Schmidt
Montag, 18.01.2010 (8:08)

Also bei mir kommt das Poster schon mal super an :)

Ich finde es verrückt, dass ich dieses Wochenende einen Artikel über die Pfadfinder Regel schreiben wollte und jetzt lese ich das erst bei Nils und dann noch hier.

Holger
Montag, 18.01.2010 (22:37)

Hi Frank,

ich habe das Poster gerade noch im A4 Format zur Verfügung gestellt. Wenn du nur die einzelnen Punkte lesen willst, kannst du auch auf das obere Bild klicken. Dort ist eine größere Ansicht verlinkt.

Grüße
Holger

Marco
Dienstag, 19.01.2010 (14:17)

Ich kenne das Buch „Clean Code“ von Robert C. Martin leider nicht, jedoch ist es seid jeher zutreffend das „Refactoring“ immer nur in kleinen Schritten erfolgt. Projekte können quasi per Definition schon keine „Refactoring’s“ sein, oftmals verbergen sich doch hinter solchen Projekten auch Wünsche für die Änderung und Verbesserung von Anforderungen an Funktionalität und dies hat dann überhaupt nichts mehr zu tun mit „Refactoring“. Hier stecken wichtigere und andere Fragen essenzieller Natur dahinter, die es zu Beantworten und zu Lösen gilt.

Grüße
Marco

Friederike Schertel
Mittwoch, 18.04.2012 (11:53)

Eine sehr schöne Zusammenfassung. Ich habe sie gleich mal ausgedruckt. :)

Auch wenn man viele der Regeln bereits kennt und befolgt lohnt es doch ab und zu einen Blick darauf zu werfen und sie sich wieder in Erinnerung zu rufen.

Vielen Dank.
Friederike

Holger
Sonntag, 22.04.2012 (10:49)

Hallo Friederike,

Danke für dein Feedback! Freut mich, dass dir die Zusammenfassung gefällt.
Die Regeln sind den meisten Entwicklern bekannt. Im Stress des Alltags gehen sie dennoch oft unter, daher die Erinnerung in Poster-Form :)

Grüße
Holger

Peter
Donnerstag, 03.01.2013 (13:38)

Das Plakat ist echt super! Habs direkt ausgedruckt und an die Wand gehangen :). Dein Blog ist jetzt auch im Reader abonniert.

Vielen Dank!
Peter

Neues Kommentar