Clean Code Developer - Roter Grad: Don't repeat yourself und Boy Scout Rule

Hallo Mensch,

an deinem ersten Tag in dem roten Grad will ich dir die ersten Praktiken und Prinzipien vorstellen. Hierbei handelt es sich um das Prinzip “Don’t repeat yourself” und die Praxis “Boy Scout Rule” bzw. die “Pfadfinderregel”.

DRY

Ergänzende eigene Gedanken zu clean-code-developer.de

Beginnen wollen wir mit Don’t repeat yourself, aka. DRY. Das Prinzip ist schnell erklärt: Schreibe den selben Code nicht mehrfach. Du willst z.B. an verschiedenen Stellen eine Liste bereinigen? Dann schreibe eine Funktion die sich darum kümmert und verwende sie an allen Stellen, die diese Funktionalität benötigen.

Warum? Ganz einfach. An allen Stellen verhält sich die Bereinigung der Liste exakt gleich. Das selbe kannst du auch mit Copy&Paste erreichen. Wenn sich jetzt aber etwas an den Anforderungen ändert, musst du es an allen Stellen anpassen, anstatt sie nur einmal zu bearbeiten. Wie schnell vergisst man dabei vielleicht sogar eine Stelle? Oder vertippt sich bei einer?

Schnell wird klar, du willst Code so oft wie möglich wiederverwenden. So kannst du dir Mühe geben, diesen Code bestmöglich zu bauen. Bestenfalls erstellst du auch gleich noch automatisierte Unittests. So hast du langfristig einen stabilen und leicht zu wartenden Code.

Also, auch wenn mal schnell gehen muss. Nehm dir kurz die Zeit und überleg, wie man Funktionalität wiederverwendbar macht. So gewinnst du am Ende sehr viel mehr Zeit, als wenn du es schnell irgendwie in die bestehende Funktion reinquetscht.

Pfadfinderregel

Ergänzende eigene Gedanken zu clean-code-developer.de

Kommen wir nun zur Pfadfinderregel, bzw. der Boy Scout Rule. Auch diese lässt sich mit wenigen Worten beschreiben: “Hinterlasse einen Ort immer in einem besseren Zustand, als du ihn vorgefunden hast.”

Was bedeutet das für die Arbeit als Programmierer*in? Du arbeitest gerade an einem Code, der schon eine Weile existiert. Z.B. soll die Reihenfolge einer Suche umgedreht werden. Wer mag schon absteigende Personen? Aufsteigend sollen sie sein!

Dabei fällt dir ein Rechtschreibfehler in einem String auf. Oder du siehst, dass hier noch ein Fehler auftreten kann, der zur Zeit nicht behandelt wird.

Dann ist jetzt deine Chance der Welt (oder zumindest der Person, die den PR reviewt) zu zeigen, was für ein großartiger Pfadfinder du hättest sein können. Pass es eben kurz an und du hast diesen Ort in einem besseren Zustand hinterlassen, als du ihn vorgefunden hast.