Clean Code – Was bei einer sauberen Programmierung wichtig ist

Clean Code - Saubere Programmierung (1)

Clean Code – Was bei einer sauberen Programmierung wichtig ist

Bald ist es wieder so weit, die neuen Auszubildenden beginnen ihre Lehre. Auch bei uns in der Entwicklung werden dieses Jahr wieder junge Menschen ausgebildet. Was ist eine der wichtigsten Botschaften, die man vermitteln sollte, wenn man jemandem das Programmieren beibringt? „Programmiere sauber, lesbar und so, dass jederzeit jemand anderes an dem Projekt arbeiten kann!“ Kurz gesagt: „Erzeuge ‚Clean Code‘“. Unsere Entwicklungsleiterin Tanja Wachno erklärt Ihnen im folgenden Beitrag, welche Faktoren zum „Clean Code“ gehören und warum sauberes Programmieren so wichtig ist.

Gepostet: 24. April 2019

Autor: Tanja Wachno

Kategorie:  IT & Software

Lesezeit: 3 Minuten

Der Begriff „Clean Code“ wurde besonders geprägt von dem gleichnamigen Buch von Robert C. Martin¹. Was aber ist sauberer Code?

Fragt man Programmierer, werden diese immer sagen, ihr Code sei gut und lesbar. Dies ist natürlich subjektiv und es kommt ziemlich sicher vor, dass andere sich über den Stil beschweren. Da ist dann schnell gesagt, der Andere hat keine Ahnung, kann nicht komplex denken, etc.

Ob dies tatsächlich so ist, stellt sich spätestens dann heraus, wenn der Schöpfer seine Kreation nach einer gewissen Zeit selbst wieder durchschauen, erweitern oder erklären muss. Wer kennt das nicht?

Wenn wir von teambasierten Entwicklungsprojekten reden, wird verständlicher, wartbarer und einfach zu debuggender Coder immer wichtiger. Nur so können Merge Requests richtig bearbeitet werden. Ebenso ist „guter“ Code ein Faktor, der „Code Review“ erheblich erleichtert.

Sätze, die man sich beim Programmieren immer wieder ins Gedächtnis rufen sollte, gehen von „Be nice to your future self“² über „Be nice to your colleagues“ bis hin zu „Code like you are programming for a psychopath who knows where your house is“³.

Spaß beiseite. Was sind die Grundpfeiler der „sauberen Programmierung“?

Clean Code - Saubere Programmierung

Clean Code Faktor #1: Kommentare

Richtig, das ist das erste, was einem einfällt, wenn man von gutem Code spricht.

ABER: Es gibt sinnvolle und nicht sinnvolle Kommentare, auf letztere sollte man verzichten. Keine Kommentare um der Kommentare Willen. Muss eine Funktion zu viel kommentiert werden, stellt sich die Frage, ob sie nicht eventuell zu kompliziert programmiert wurde. „Don’t comment bad code – rewrite it“⁴. Dieses Konzept ist auch übertragbar auf Commit Messages.

Clean Code Faktor #2: Optische Faktoren

Code ist dann gut lesbar, wenn er auch gut formatiert ist. Am Besten wird dies in Form eines Styleguides festgelegt. Auch hier gilt: Manchmal ist weniger mehr! Man muss nicht bis zum letzten Semikolon alles vordefinieren. Ein Leitfaden, der gemeinsam von den Entwicklern entwickelt wurde und an den sich alle halten, ist aber sehr hilfreich.

Je nach Compiler kann man das „Regelwerk“ in der Entwicklungsumgebung hinterlegen, sodass man gleich einen freundlichen Hinweis erhält, wenn man dagegen verstößt:

Clean Code - CompilerMessage Styleguide

Clean Code Faktor #3: Namen

Namen von Funktionen und Variablen sollten sprechend sein.

Vor langer Zeit, als ich meine Ausbildung angefangen habe, gab es des Öfteren noch Code, in dem (etwas überspitzt) Variablen von A1 bis Z100 durchnummeriert waren. Dies gehört – so hoffe ich – der Vergangenheit an. Man sollte aus einem Funktionsnamen herauslesen können, was diese tut. Variablen sollten verraten, was sie beinhalten.

Clean Code Faktor #4: Funktionen

Abgesehen von den Namen sollten auch die Funktionen selbst kurz und verständlich gehalten werden. Sie benötigen klare Argumente bei den Aufrufen und auch nur so viele Argumente, wie unbedingt nötig. Spätestens wenn man feststellt, dass man aus einer Funktion nun schon mehrfach Code kopiert und in andere Funktionen eingefügt hat, sollte man darüber nachdenken, diesen Code in eine neue Funktion auszulagern anstatt ihn zu kopieren.

Clean Code - Saubere Programmierung (2)

Clean Code – Was sonst noch wichtig ist

Natürlich gibt es noch viele weitere Faktoren zum Thema Clean Code. Nicht umsonst gibt es zu diesem Thema diverse Artikel und ganze Bücher. Die besprochenen Faktoren waren nur ein kleiner Abriss dessen, was wir bei unserer täglichen Arbeit leben und stetig zu verbessern versuchen. Und natürlich ist es auch das, was wir unseren Auszubildenden von Anfang an vermitteln möchten.

Was auch immer man für Regeln oder Styleguides ansetzt: Das gesamte Team muss sie unterstützen und einhalten. Daher ist es gut, wenn man auch immer mal wieder gemeinsam darüber redet und hin und wieder nachbessert, wenn man durch die Erfahrungen der Teammitglieder eines Besseren belehrt wird.

Quellen:

¹Robert C. Martin: „Clean Code: A Handbook of Agile Software Craftsmanship“

²Fabiola De la Cueva, Delacor

³Fabiola De la Cueva, Delacor

⁴Brian W. Kerighan and P. J. Plaugher: „The elements of Programming Style“

Bildquellen: Fatos Bytyqi Clément H 

Sie wollen keinen Blogbeitrag mehr verpassen?

Zur Newsletteranmeldung
Titel Whitepaper HR Trends

HR-Trends: Was bewegt das Personalmanagement 2019?

Wir haben auf 32 Seiten die HR-Trends 2019 für Sie zusammengestellt – angefangen bei der digitalen Transformation, über neue Arbeitsmodelle bis hin zu Gamifying HR-Management. Aktuelle Buzzwords und Entwicklungen werden in unserem Whitepaper verständlich erklärt und Tipps für die Umsetzung erleichtern die Einführung in Ihrem Unternehmen!

Zum Whitepaper
2019-06-13T14:57:43+01:00

Möchten Sie uns dazu etwas sagen?