Clean Code Prinzipien | Lesbarer C# Code Tutorial

Best Practices für verständlichen und wartbaren Code

‍

Clean Code Prinzipien | Lesbarer C# Code Tutorial

Im Kontext von Clean Code Prinzipien und einem Lesbarer C# Code Tutorial kann es in der Programmierung mit der Zeit passieren, dass Klassen für Programmierer*innen unübersichtlich werden und nicht mehr klar ist, wofür bestimmte Methoden oder Codezeilen programmiert wurden.

Gelegentlich finden sich auch ganze Codezeilen auskommentiert im Code wieder, die in Vergessenheit geraten, und irgendwann weiß vielleicht niemand mehr, warum sie ursprünglich programmiert wurden. Schließlich kennen wir alle den berühmten Satz: „Behalte das mal lieber, vielleicht kann man es ja nochmal gebrauchen.“

In der Programmierung scheint dieser Satz unbewusst auch zu existieren, wodurch solcher Code entsteht:

‍

‍

Dies ist natürlich nur ein Beispiel. Manchmal finden sich auch ganze Klassen auskommentiert im Code wieder, und mit der Zeit wird es unübersichtlich.

‍

Wie sollte Code gestaltet sein, damit er für jede Person lesbar wird?

Für diese Frage gibt es keine Patentlösung, und ob Kommentare hierbei eine Rolle spielen sollten, bleibt jedem selbst überlassen.

Wir möchten Ihnen dennoch ein paar Tipps geben, wie Sie es in Ihrem Entwicklungsalltag einfacher haben können. Es gibt unterschiedliche Möglichkeiten, die wir aber nicht alle im Detail beleuchten können.

‍

Kommentare im Code

Sprache

‍
Sie können Ihre Kommentare in der Sprache gestalten, die Sie für sinnvoll erachten. Sind Ihre Entwickler international, empfiehlt es sich, die Kommentare auf Englisch zu verfassen. Nutzen alle Entwickler*innen hingegen dieselbe Sprache, können die Kommentare auch in der bekannten Umgangssprache geschrieben werden.

‍

‍

Unterschiedliche Arten von Kommentaren

‍
In diesem Artikel haben Sie bereits zwei Arten von Kommentaren kennengelernt. Es gibt verschiedene Varianten von Kommentaren, die wir hier kurz darstellen möchten:
(Hier könnte eine detaillierte Beschreibung der verschiedenen Kommentararten eingefügt werden)

‍

‍

Wann ist es sinnvoll, meinen Code zu kommentieren?

‍
Diese Frage lässt sich nicht pauschal beantworten und hängt sowohl von den individuellen Vorlieben der Entwickler*innen als auch von den Vorgaben der jeweiligen Firma ab. Ein passender Ansatz lautet: „In Maßen, nicht in Massen.“

‍

Setzen Sie genau so viele Kommentare, wie Sie benötigen, um unübersichtliche Stellen in Ihrem Code zu erklären. Achten Sie darauf, dass der Code durch zu viele Kommentare nicht an Übersichtlichkeit verliert. Kommentieren Sie nur das, was nötig ist und sich nicht von selbst erklärt.

‍

Beispiel für einen sinnlosen Kommentar:

‍

Methoden und Klassen zielführend benennen

Sie sollten Ihre Methoden und Klassen so selbsterklärend wie möglich benennen, damit Sie keine zusätzlichen Kommentare zur Erklärung benötigen.

Beispiel:

‍

Region und Endregion-Pragma nutzen

Sie können auch das Region/Endregion-Pragma nutzen, um Ihren Code übersichtlicher zu gestalten. Dies ist besonders nützlich in Klassen mit vielen Zeilen, da Abschnitte auf- und zugeklappt werden können.

Zugeklappt:

Aufgeklappt:

Die Klasse wird dadurch lesbarer und übersichtlicher, da nicht benötigte Codezeilen beim Analysieren ausgeblendet werden können.