Halte deinen Code sauber!

Vor einer Woche habe ich einen Vortrag vor Entwicklern für Embedded Systems gehalten, der sich mit dem Thema “Clean Code” beschäftigt hat. Die Zeit war leider begrenzt, sont hätte ich gut 5 Stunden und 100 Prinzipien vortragen können.

Hier die aus meiner Sicht die 6 wichtigsten Regeln für das Arbeiten mit Quellcode im Team:

1. Keep it simple, stupid (KISS)

Man sollte immer die einfache Lösung anstreben. Die neuste “Bleeding Edge Technologie” einzusetzen hilft nicht immer weiter. Auch wenn der Code nach 6 Wochen schon nicht mehr zu verstehen ist, entstehen bei der Fehlersuche und Wartung Probleme.

2. Single Responsible Priciple

Eine Codezeile sollte immer eine Sache machen! Die Zuständigkeit einer Funktion/Mehtode sollte eindeutig sein! Eine Klasse soll nur eine Aufgabe erfüllen…

3. Die Pfadfinderregel beachten

Fällt bei Wartungsarbeiten an Quellcode auf, dass dieser mal überarbeitet werden müsste, ist es an der Zeit dies auch zu tun. Baut man seine Änderungen nur ran, so hinterlässt man noch viel schlimmeren Code, den sicherlich bald keiner mehr versteht. Code muss ständig aufgeräumt werden, sonst entsteht das sogenannte “Broken Windows” Phänomen.

4. Don’t repeat yourself

Eine der wichtigsten Regeln… ist aber schon so oft erörtert wurden, dass ich diese hier nur der Vollständigkeit halber aufzähle. lies mehr…

5. Use Coding Conventions

Wenn man im Team am gleichen Code arbeitet, sollte man auch gleiche Regeln haben nach dem man Code entwickelt. Dies fängt damit an, wo eine Klammer hinkommt und geht bis zu Bezeichnungsvorschriften von Methoden- oder Klassennamen. Eigentlich beinhaltet das auch alle vorangegangenen Regeln, denn KISS ist ja beispielsweise auch eine Konvention, die jeder im Team einhalten sollte.

6. Use Version Control

Wenn ich diesen Vortrag nicht vor Entwickler für Embedded Systems gehalten hätte, würde dieser Punkt wohl “Benutze moderne Tools” heißen. Ich bin der Meinung man sollte heutzutage keine Codezeile mehr ohne Versionskontrolle, Continuous Integration, automatisierte Tests… schreiben.

Hier meine Slides:

Wie gesagt. Ich könnte noch viel mehr Punkte aufführen wie “Root Cause Analyse”, “Favor Composition over Inheritance”, “Separation of Concerns”… Ich hatte aber nur 20 Minuten Zeit.