Clean Code GUIDE 2: Beispiele + simple Erklärungen

Bedeutet Clean Code nur "gut"-benannte Funktionen und Variablen?

Nein!

In dem zweiten Teil des Clean Code Guides gehe ich auf die Handhabung von Verwendung von Parameter, das Geheimnis der Kommentare, perfekte Formatierung und praktisches Refactoring eingehen.

Verbessere HEUTE den Code Deines Projekts!

 

Parameter und Clean Code

Ein wesentlicher Bestandteil von Funktionen sind die Parameter.

Zur Übersichtlichkeit sollte keine Funktion mehr als 3 Variablen haben. MAX: 3.

Übergebe keine Werte mit den Funktionen, sondern versuche nur globale Variablen anzulegen, die genutzt werden, um die Daten zu modifizieren.

 

💣Coding Horror - So nicht!

Parameter verbessern nicht die Lesbarkeit.

👌 Clean Code - So sollte Dein Code aussehen

Globale Variablen sind die Lösung. Bedenke diese auf private für die Klasse zu setzen.

Kommentare in Clean Code

Ein perfekter Clean Code braucht keine Kommentare.

Ein Clean Code ist gut lesbar und einfach verständlich, egal wie komplex der Algorithmus sind.

Komplexere Algorithmen erklärt Clean Code mit vielen Funktionen, guten Benennungen und einer durchdachten Struktur.

Mit Clean Code kann ein guter Programmierer komplexe Algorithmen einfach verständlich machen.

Wenn Du ein Kommentar schreiben solltest. Dann beantworte nicht das was oder wie, sondern Kommentare erklären das Warum oder Wieso

// parst die HTTP-Antwort in XML zu einem neunen JSON Format

parseXMLtoJSON(){…}

Nutze liebe solche:

// API kann nicht XML verarbeiten und braucht JSON

parseXMLtoJSON(){…}

Ein guter Kommentar soll so knapp wie möglich das Problem erklären und dem Leser weiterhelfen.

Kommentiere bitte nicht ungültigen Code aus, sondern nutze Git um auf alten Code zugreifen zu können.

Vermeide Deine Aufgaben in die den Code zu schreiben. Todos gehören in eine Ticketsystem wie Jira oder Todoist.

 

💣Coding Horror - So nicht!

Vermeide oberflächliche Kommentare, die nur ein "Was" beschreiben.

👌 Clean Code - So sollte Dein Code aussehen

Weniger ist mehr. Ein Kommentar soll nur das "Wie" beschreiben... oder nicht existieren.

Struktur eines Clean Code

Ordner Struktur

Bevor Du Dein Projekt startest, überlege Dir vorher, was in Deinem Projekt vorhanden sein soll. Z.B.

  • Bilder
  • Schriftarten
  • Grafiken
  • Hilfsklassen

Erstelle Dir dann neben dem normalen Code in dem Root Ordner Deines Projektes Diese Ordner.

Nutze eine gut überlegte Ordner- und Dateistruktur in Deinem Projekt

Bei Java und manchen Frameworks sind bereits solche Ordner vorhanden. Die Dokumentation des entsprechenden Frameworks beschreibt Best Practice und Empfehlung für die Gliederung.

Länge Dateien bei Clean Code

Ich empfehle nicht mehr als 300 - 500 Zeilen Code in eine Datei zu schreiben, da…

  1. … Du schneller Funktionen findest.
  2. … Du keine wunden Finger vom vielen Scrollen bekommst.

Außerdem empfehle ich Dir die Outline Deiner IDE (Entwicklungsumgebung) zu nutzen. Die Outline stellt das Inhaltsverzeichnis Deiner Datei dar und listet Variable und Funktionen-Namen auf.

Um Code auszulagern, kannst Du Refactoring nutzen oder neue Klassen „entdecken“.

Ein guter Programmierer überlegt sich vor dem Coden, welche Klassen für das Projekt relevant sind. Dieser erstellt ER-Diagramme und versucht alle Klassen aus der Realität zu bestimmen und zu logisch zu benennen.

Wenn Deine Datei über 500 Zeilen anwächst, kannst Du bestimmt ein Muster erkennen, aus dem Du eine neue Klasse extrahieren kannst. Erstelle eine neue Datei oder schreibe eine neue Klasse.

 

Formatierung im Clean Code

Clean Code ist gut formatierter Code. Versuche die folgenden vier Aufgaben in Deinem Code umzusetzen.

1.   Bündle vergleichbare Funktionen und Variablen

Ähnliche Funktion gehören direkt untereinander. Du kannst Dich an den Präfixen der Funktionen orientieren

Bei Variablen bündelst Du Variablen mit einem Absatz.

2.   Lagere Code aus

Eine Datei mit 300 – 500 Zeilen kann schnell unübersichtlich sein.

Deshalb versuche Funktionen und Variablen auszulagern. Versuche eine weitere globale Klasse aus dem bestehenden Code zu extrahieren oder einen Helper-Klasse zu erstellen.

3.   Verwende Leerräume für mehr Struktur

Nutze einen leeren Absatz, um Variablen zu bündeln. Bündele thematisch und inhaltlich ähnliche Variablen.

Nutze zwei leere Absätze, um einzelne Funktionen von einander zu separieren.

Bitte verwende den Tabulator-Leerschritt nur am Anfang der Zeile und versuche keine „Tabellen“ mit dem Tabulator zu bauen.

4.   Vermeide Schachtelung mit vielen Stufen

Wenn Du mehrere For-Schleifen, if-Anweisungen und komplexere Funktionsaufrufe nutzt, dann können Codezeilen relativ weit rechts beginnen.

Wenn Du zu viele Schachtelung hast, kannst Du den Code nicht mehr lesen, bzw. muss beim Ändern, die einzelnen Klammern zählen.

Im Kapitel Funktonen bin ich darauf eingegangen, dass Du die Funktionen kaskakdieren sollst. Verwende max. 4 Ebenen. Verwende Funktionen, die schrittweise 30+ Funktionen aufrufen.

 

Refactoring

Wenn Du unausgereiften Code zu einem Clean Code verändern möchtest, dann brauchst Du „Refactoring“-Werkzeuge. Ein Refactoring-Werkzeug ist ein verbessertes Ersetze-Werkzeug, welches jede gute IDE / Entwicklungsumgebung bereitstellt.

Wenn Du z. B. einen Funktionsnamen im Projekt änderst, dann musst Du alle Funktionsnamen im Projekt anpassen, sonst spukt der PC die Fehlermeldung „function not found“ aus. Die Refactoring-Tools sind praktisch, arbeiten aber nicht immer wie der Programmierer sich das optimalerweise vorstellt.

Das Tool kann je nach Konfiguration in einer anderen Datei eine gleich benannte Funktion, obwohl Du es nicht wolltest

Clean Code mit Visual Studio Code

Um in Visual Studio Code zu refactoren, musst Du die Variable- / Funktionsname selektieren und dann F2 drücken. Dann erscheint darunter ein Eingabefeld. Mit Enter bestätigst Du die Änderung. Visual Studio Code ändert alle Referenzen zeitgleich.

Ich empfehle Dir danach den Code mit jedem Refactoring-Schritt zu testen, da ungewolltes Refactoring schnell passieren kann.

Denke daran, dass Du die Variablennamen in Deiner Dokumentation anzupassen

Eclipse Refactoring ist einfach

Mit ALT + STRG + R ermöglicht den gleichen Effekt. Bei Eclipse erscheint kein Feld, sondern Du kannst in Realtime alle Werte mit bloßem Editieren ändern.

So macht Refactoring Spaß.

Learnings für dieses Kapitel

  • Der beste Kommentar ist kein Kommentar.
  • Nutze nie mehr  als 3 Parameter in einer Funktion. Verwende globale Variablen.
  • Nutze eine gut überlegte Ordner- und Dateistruktur in Deinem Projekt
  • Ab 500 Zeilen musst Du die Datei teilen
  • Refactoring ist Dein Freund.

Nächste Kapitel

Kapitel 3: Clean Code ist besser: Kürzen und Optimieren
Clean Code ist nicht nur eine Hülle. Richtig guter Code ist Speicher und CPU schonend. Außerdem skaliert diese gut.

1 Star2 Stars3 Stars4 Stars5 Stars (7 votes, average: 4,14 out of 5)
Loading...

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.