Definition „Clean Code Principles“ Einfacher Code dank Clean-Code-Prinzipien

Anbieter zum Thema

DAXTEN GmbH

Kentix GmbH

ConSysTech GmbH

Softwarecode kann bisweilen schwer verständlich sein. Durch die Anwendung von Clean Code Principles können Entwickler intuitiv verständlichen, einfachen, leicht veränderbaren Code generieren, der dennoch alle Anforderungen der Anwendung erfüllt.

Was sind Clean Code Principles?

Clean Code Principles folgen keinem strengen Regelwerk. Stattdessen weist der Begriff, der sich grob auf den US-amerikanischen Softwareentwickler Robert Cecil Martin zurückverfolgen lässt, auf einige lose Prinzipien hin.

Diese sollen dazu dienen, „sauberen“ Code zu schreiben, der schnell verständlich und gleichzeitig leicht zu ändern ist. Mit „Verständnis“ ist gemeint, dass Softwareentwickler den Code schnell erfassen können – ohne Rückfragen stellen oder eine umfangreiche Dokumentation lesen zu müssen.

Was macht Clean Code aus?

Mehrere Eigenschaften machen aus allgemeinem Code eher sauberen Code. Dazu zählen unter anderem:

• Eine sinnvolle und klare Strukturierung der Abläufe von Ausführungen innerhalb der gesamten App.

• Eine eindeutig erkennbarer Zusammenhang zwischen den verschiedenen Teilen des Codes.

• Eine schnelle Verständlichkeit aller Methoden, Variablen, Klassen und Funktionen. Welche Aufgabe beziehungsweise Rolle diese haben, sollte sofort erkennbar sein.

Zudem besagen die Clean Code Principles, dass Code leicht anpassbar sein sollte. Dies macht es einfacher, Fehler zu beheben. Haben selbst kleinste Veränderungen weitreichende Konsequenzen, kann die Fehlersuche beziehungsweise die Beseitigung der Fehler deutlich komplexer werden als mit sauberem Code. Anpassbarer Code erlaubt außerdem generell eine einfache Weiterentwicklung der Anwendung - besonders, wenn die Software von Drittentwicklern weitergeschrieben werden soll.

Diese Ziele führen dazu, dass innerhalb des Codes beispielsweise Methoden und Klassen möglichst klein bleiben sollten. Eine einzige Aufgabe pro Klasse und Methode sollte das Ziel sein. Ausreichend gut dokumentierte APIs tragen ihren Teil dazu bei, die Arbeit mit dem Code zu erleichtern.

Was ist das Ziel der Clean Code Principles?

Für einen einzigen Entwickler spielt es theoretisch keine Rolle, ob der eigene Code „sauber“ ist oder nicht. Sofern diese Person den Code versteht, kann die Entwicklung am Programm fortgesetzt werden.

Problematisch wird die Abkehr von Clean Code Principles, wenn andere Entwickler die Arbeit des ursprünglichen Entwicklers weiterführen sollen. Ist der Code nicht oder nur schwer verständlich, verzögert dies die Arbeiten an dem Projekt erheblich.

Sauberer Code führt dazu, dass alle Entwickler die Arbeit an einer Software theoretisch weiterführen könnten. Dies hat Vorteile auch dann, wenn keine eigentliche Weiterentwicklung geplant ist, sondern „nur“ Bugs gesucht werden: In klar verständlichem Code lassen diese sich einfacher finden, was die Wartungsarbeiten an bestehendem Code verkürzt.

Welche Grundprinzipien sind für Clean Code Principles wichtig?

Es gibt diverse Akronyme, die sich im Laufe der Zeit als wichtige Standbeine für Clean Code Principles etabliert haben. Einige davon lauten wie folgt:

• KISS bedeutet „Keep It Simple, Stupid“ und ist bereits mindestens 60 Jahre alt. Die Anweisung soll bedeuten, dass der Code möglichst einfach gehalten werden sollte. Unnötige Komplexität macht Code schwer verständlich und führt zu Problemen. Entwickler sollten daher überlegen, wie sich ein Problem am elegantesten und einfachsten lösen lässt.

• YAGNI heißt „You Aren't Gonna Need It“ und soll auf Codepartikel hinweisen, die schlicht nicht gebraucht werden. Funktionen im Code, die für die Software unbedeutend sind, haben dort nichts zu suchen. Eine möglichst effiziente Lösung des Problems, ohne Funktionen einzubauen, die aktuell nicht gebraucht werden, ist somit das Standbein von YAGNI.

• DRY weist auf „Don't Repeat Yourself“ hin. Funktionen im Code sollten nur einen eindeutigen und einzigen Zweck haben. Eine doppelte (oder noch häufigere) Abrufung von Informationen, die dann für unterschiedliche Aktionen genutzt werden, ist das Gegenteil von DRY. Die Bündelung wichtiger Funktionen, sofern möglich, ist immer vorzuziehen.

Diese und ähnliche Prinzipien sind einige der Grundpfeiler der Clean Code Principles.

Unterschied zwischen Mensch und Maschine

Für eine Maschine ist die Komplexität des Codes prinzipiell unbedeutend. Sofern sie die Software ausführen kann, ist es dem Gerät egal, ob der Code „sauber“ ist oder nicht.

Möglichst kurzer, prägnanter Code ist aber aus menschlicher Sicht nicht immer besser. Das gilt insbesondere in Teams, in denen andere Personen den Code verstehen müssen. Beispielsweise könnte eine Variable schlicht „x“ genannt werden. Im weiteren Verlauf des Codes kann der Entwickler, der „x“ deklariert hat, damit arbeiten. Andere Entwickler wissen jedoch nicht, was sich hinter „x“ verbirgt.

Dies wäre ein Punkt, an dem Kürze für Lesbarkeit geopfert werden sollte. Heißt die Variable nicht „x“, sondern beispielsweise „ZeitSeitProgrammstart“, ist sofort klar, was mit dieser Variable gemeint ist. Obwohl beide Variablen eine identische Funktion haben, ist die zweite Benennung für andere Entwickler verständlich, während „x“ keine Aussagekraft besitzt. Clean Code Principles sind daher bedeutend, um anderen Entwicklern den Umgang mit eigenem Code so leicht wie möglich zu machen.

(ID:49324188)