24.07.2024

5 min

Warum es wichtig ist, sauberen Code zu schreiben

content image

«Clean Code» ist mehr als nur ein Schlagwort – es ist ein wesentliches Prinzip der Softwareentwicklung. Es geht darum, Code nicht nur funktionsfähig, sondern auch klar verständlich, wartungsfreundlich und flexibel zu gestalten. Warum das auch für unsere Kunden wichtig ist, erfahren Sie im folgenden Artikel.

author image

Mike Züger

Inhaber / Geschäftsführer
Software Development und Design

Worum geht es bei «Clean Code» überhaupt?

Es gibt immer eine Ausrede, warum man gerade keinen guten Code schreiben kann, doch am Ende bleibt es nur eine Ausrede. Ein schlechter Programmierer erstellt Quellcode, ohne sich gross über die Konsequenzen Gedanken zu machen, nach dem Motto: «Solange es läuft, ist es in Ordnung.»

Clean Code ist kein strenges Regelwerk, sondern beschreibt eine Reihe von Prinzipien, die darauf abzielen, Code zu produzieren, der intuitiv verständlich, einfach wartbar und erweiterbar ist. Verständlich bedeutet hier, dass der Code von jedem erfahrenen Entwickler sofort erfasst werden kann und die Zusammenhänge klar und nachvollziehbar dargestellt sind. Der Begriff «Clean Code» wurde hauptsächlich von Robert C. Martin geprägt, einem Softwareentwickler und Autor, der auch als «Uncle Bob» bekannt ist. In Fachkreisen oft als eine Art Bibel zu diesem Thema angesehen, empfehle ich die folgende Literatur: «Clean Code: A Handbook of Agile Software Craftsmanship».

Clean code always looks like it was written by someone who cares. – Robert C. Martin

Wie finde ich Zeit für Clean Code?

Die wahre Herausforderung beim Clean Coding liegt nicht darin, den Wunsch zu haben, exzellenten Code zu schreiben. Wer möchte nicht eine elegante, fehlerfreie Lösung schaffen, die in der Entwicklergemeinschaft bewundert wird? Der Knackpunkt ist vielmehr, den Wert dieser Sorgfalt gegenüber den Kunden zu vermitteln und sicherzustellen, dass die notwendige Zeit und der Aufwand angemessen vergütet werden.

Zu Beginn ist der Aufwand beträchtlich. Besonders die detaillierte Planung der Architektur und das Verständnis der Clean Code-Prinzipien erfordern Zeit. Aber es geht nicht nur darum, dass die Entwickler die Regeln kennen; das gesamte Team muss ein gemeinsames Verständnis für die Philosophie des Clean Code haben. Das bedeutet, dass nicht nur Code-Nerds, sondern auch Product Owner und Projektleiter den Mehrwert erkennen und unterstützen müssen. Es lohnt sich also, Zeit in die Überzeugungsarbeit zu investieren, um sicherzustellen, dass sowohl das Team als auch die Kunden bereit sind, in hochwertigen Code zu investieren.

Wie Software-Prinzipien auch im Alltag effektiv sein können

KISS – Die Kunst der Einfachheit

KISS, was für «Keep it simple and stupid» steht, zählt zu den ältesten und bewährtesten Prinzipien im Clean Code. Das KISS-Prinzip gilt als zeitloser Leitfaden für die Programmierung. Es erinnert uns daran, den Code so klar und unkompliziert wie möglich zu halten. Komplexität ist oft der Feind der Effizienz, und genau das gilt es zu vermeiden.

Unnötige Wiederholungen vermeiden: DRY

DRY, was für «Don’t Repeat Yourself» steht, ist ein fundamentales Prinzip in der Softwareentwicklung, das darauf abzielt, Redundanz im Code zu vermeiden. Die Grundidee von DRY ist einfach: Es sollte vermieden werden, denselben Code mehr als einmal zu schreiben. Stattdessen sollten wiederkehrende Codeabschnitte an einer einzigen, zentralen Stelle definiert werden.

Oft können solche Prinzipien aus der Softwareentwicklung auch auf andere Bereiche Ihres Projekts und Alltags angewendet werden. Bei der Lösung von Problemen wird manchmal dazu geneigt, unnötig komplexe Wege zu wählen, obwohl eine elegante, pragmatische Lösung oft viel effektiver wäre. Ihre täglichen Aufgaben sollten einmal genauer betrachtet werden: Gibt es wiederkehrende Tätigkeiten, die immer wieder von Hand erledigt werden? Vielleicht ist dies eine Gelegenheit, das DRY-Prinzip anzuwenden und sich zu fragen: «Wird dieser Task regelmässig wiederholt? Wie könnte er vereinfacht oder automatisiert werden?»

0 %

der Kosten in der Softwareentwicklung sind Wartungskosten.

Warum ist Clean Code wichtig?

Wartungskosten: Der langfristige Blick

Stellen Sie sich vor, Sie bauen ein luxuriöses Haus. Wenn Sie beim Bau die besten Materialien und eine solide Struktur verwenden, werden Sie in den kommenden Jahren weniger Reparaturen und Renovierungen benötigen. Ähnlich verhält es sich mit Clean Code. Studien zeigen, dass etwa 80% der Gesamtkosten eines Softwareprojekts für Wartung und Erweiterungen aufgewendet werden. Wenn Sie von Anfang an sauberen, verständlichen Code nutzen, reduzieren Sie langfristig die Kosten für Wartung und Anpassungen erheblich.

Der Code als Gedicht

Guter Code ist wie ein Gedicht, das leicht zu verstehen ist. Wenn Sie ein Gedicht mit komplizierten Metaphern und verschlüsselten Botschaften schreiben, wird es für den Leser mühsam, den Inhalt zu erfassen. So verhält es sich auch mit Code. Die hauptsächliche Arbeit in einem Projekt besteht oft nicht darin, neuen Code zu schreiben, sondern bestehenden Code zu lesen und zu verstehen. Ein klar strukturierter und gut dokumentierter Code erleichtert das Verständnis und reduziert die Zeit, die für Fehlerbehebungen und Anpassungen benötigt wird.

Dies verringert das Risiko, dass eine einzige Person für das Verständnis und die Wartung des Codes verantwortlich ist.

Fehlerbehebung im Dschungel

Fehlerbehebungen können in einem unübersichtlichen Code-Dschungel schnell zu neuen Problemen führen. Clean Code sorgt für eine klare, strukturierte Umgebung, die es Ihnen ermöglicht, Fehler effizienter zu finden und zu beheben, ohne neue Fehler einzuführen.

Die Kosten der Fehlentscheidung

Wenn zu Beginn eines Projekts an der Codequalität gespart wird, kann dies zu erheblichen Mehrkosten führen, wenn der Code später geändert oder gewartet werden muss. Ein kleines Investment in guten Code zu Beginn kann sich als grosse Ersparnis am Ende erweisen.

Die Bedeutung automatisierter Tests

Ohne automatisierte Tests besteht bei jeder Änderung das Risiko, unbeabsichtigt Fehler einzuführen, was sich häufig bewahrheitet und die Stabilität der Software beeinträchtigt.

Durch das Hinzufügen von Unit-Tests können Fehler im Code frühzeitig entdeckt und umgehend behoben werden, was die Stabilität des Produkts erhöht.

Die Kunden-Perspektive

Clean Code gewährleistet Ihnen als Kunden ein stabileres und zuverlässigeres Softwareprodukt. Ein gut strukturierter Code erleichtert Änderungen und Erweiterungen, minimiert das Risiko neuer Fehler und führt zu einer besseren Benutzererfahrung sowie niedrigeren langfristigen Kosten. Clean Code ist daher nicht nur eine Entwickler-Etikette, sondern eine wichtige Voraussetzung für effiziente und kosteneffektive Softwareprojekte.

Clean Code Prinzipien, an die man sich auch unter Zeitdruck immer halten kann

YAGNI – You Ain't Gonna Need It

Es sollte vermieden werden, zusätzliche Features oder Funktionalitäten zu implementieren, die aktuell noch nicht benötigt werden. Oftmals wird dazu geneigt, mehr zu entwickeln, als tatsächlich erforderlich ist, oder Features werden noch nicht bis ins Detail spezifiziert. Um effizient zu arbeiten, sollte der Fokus auf dem liegen, was im Moment tatsächlich gebraucht wird, und zusätzliche Funktionen sollten aufgeschoben werden, bis sie wirklich notwendig werden.

Jeder Kommentar ist ein Misserfolg

Es sollte versucht werden, den Code so klar und verständlich zu schreiben, dass Kommentare nicht nötig sind. Der Code sollte sich selbst erklären, indem sprechende Methodennamen, aussagekräftige Variablennamen und eine klare Struktur verwendet werden. Kommentare sollten wirklich nur dann eingesetzt werden, wenn sie zusätzliche Kontextinformationen bieten, die aus dem Code selbst nicht ersichtlich sind.

Boy-Scout Rule

Der Code sollte immer in einem besseren Zustand hinterlassen werden, als er vorgefunden wurde. Diese Regel bedeutet, dass stets eine Verbesserung angestrebt werden sollte, sei es durch Refactoring, Optimierung oder das Entfernen von veraltetem Code.

Kontinuierliche Optimierung

Kontinuierliche Optimierung reduziert die technische Schulden einer Software, die sich ansammeln und irgendwann so gross werden können, dass die Software nicht mehr überarbeitet werden kann, sondern komplett neu gebaut werden muss.

Fazit

Clean Code ist nicht nur für Entwickler vorteilhaft, sondern auch für Kunden. Sauberer Code verbessert die Zuverlässigkeit der Software, ermöglicht schnellere Weiterentwicklungen, reduziert die Wartungskosten und sorgt für Zukunftssicherheit. Dies bedeutet für Kunden weniger Ausfallzeiten, geringere Kosten für Anpassungen und eine langfristige Investitionssicherheit. Zusammengefasst: Clean Code führt zu einer besseren und wirtschaftlicheren Softwarelösung.