Clean Coding

Um die Prinzipien und Praktiken des Clean Code Development (CCD) besser zu strukturieren und anzuwenden, sind diese in unterschiedliche Grade eingeteilt. Diese Grade helfen Entwicklerinnen und Entwicklern, den Überblick zu behalten und sich im Clean Coding kontinuierlich zu verbessern. Die Grade reichen von Schwarz bis Weiß, wobei jeder Grad spezifische Prinzipien und Praktiken umfasst. Im Folgenden beschreiben wir nur einige Beispiele aus diesen Prinzipien und Praktiken – es gibt jedoch noch viele weitere, die in den jeweiligen Graden enthalten sind.

0. Schwarzer Grad

Der schwarze Grad zeigt das grundsätzliche Interesse an Clean Code Development, ohne jedoch die Prinzipien aktiv anzuwenden.

1. Roter Grad

Im roten Grad beginnt man, grundlegende CCD-Prinzipien und -Praktiken in die tägliche Arbeit einzubringen.

Prinzipien:

• Don’t Repeat Yourself (DRY): Vermeide Wiederholungen beim Clean Coding, um Änderungen zentral und effizient an einer einzigen Stelle vornehmen zu können.
• Keep it Simple, Stupid (KISS): Halte den Code so einfach wie möglich, um die Verständlichkeit für andere Entwickler zu verbessern und die Wandelbarkeit zu erhöhen.

Praktiken:

• Boy Scout Rule: Hinterlasse den Code stets ein wenig besser, als du ihn vorgefunden hast. Selbst kleine Verbesserungen fördern die kontinuierliche Steigerung der Codequalität.

• Simple Refactorings: Führe einfache Umstrukturierungen durch, um den Code schrittweise zu verbessern. So erhöhst du die Lesbarkeit und Wartbarkeit, ohne neue Fehler einzuführen.

   

2. Orangener Grad

Der Fokus liegt auf der Anwendung von Prinzipien auf Klassenebene.

Prinzipien:

• Source Code-Konventionen: Einhaltung von einheitlichen Code-Konventionen erleichtert das Lesen und Verstehen des Codes.
• Single Responsibility Principle (SRP): Jede Klasse sollte nur eine Verantwortlichkeit haben. Das reduziert die Notwendigkeit, viele Klassen bei Änderungen anzupassen, und vermeidet komplexe Kopplungen.

Praktiken:

• Issue Tracking: Aufgaben und Fehler im Code systematisch verfolgen, um einen klaren Überblick zu behalten. Diese Praktik des Clean Coding erleichtert die effiziente Bearbeitung und Delegation aller offenen Punkte.
• Reviews: Regelmäßige Überprüfung des Codes durch Teammitglieder fördert die Identifikation von Schwächen und Verbesserungsmöglichkeiten.

3. Gelber Grad

Dieser Grad betont strukturierte und wartbare Codes.

Prinzipien:

• Principle of Least Astonishment: Der Code sollte sich so verhalten, wie die Leserin oder der Leser es erwartet, um Überraschungen und unnötige Komplikationen zu vermeiden.
• Information Hiding Principle: Vermeidung der Preisgabe unnötiger Informationen, um die Abhängigkeiten zu reduzieren und die Wandelbarkeit der Software zu erhöhen.

Praktiken:

• Mockups: Erstellung von Dummy-Klassen, die als Ersatz für Komponenten verwendet werden, um Abhängigkeiten während des Testens zu isolieren und kontrollierbare Tests durchzuführen.
• Automatisierte Unit Tests: Automatisierung von Tests zur Überprüfung der Funktionalität einzelner Codeeinheiten, um Zeit zu sparen und Fehler frühzeitig zu erkennen.

4. Grüner Grad

Kontinuierliche Verbesserung steht im Vordergrund, insbesondere durch ein bewusstes Abhängigkeitsmanagement.

Prinzipien:

• Open Closed Principle: Softwaremodule sollten offen für Erweiterungen, aber geschlossen für Modifikationen sein. Das bedeutet, dass Änderungen und Erweiterungen der Funktionalität durch Hinzufügen neuer Codekomponenten erfolgen sollten, ohne den bestehenden Code zu verändern.

Praktiken:

• Anwendung von Metriken: Verwendung von Metriken zur Messung und Verbesserung der Codequalität. Metriken helfen die Codequalität objektiv zu bewerten und Verbesserungspotenziale zu identifizieren z. B., um die Testabdeckung zu bestimmen.

5. Blauer Grad

Der höchste Grad stellt die Verbindung zwischen CCD und Softwarearchitektur her.

Prinzipien:

• You Ain’t Gonna Need It (YAGNI): Implementiere nur das, was wirklich benötigt wird. Das vermeidet unnötige Komplexität, spart Ressourcen und macht die Software flexibler und wartbarer.
• Implementierung spiegelt Entwurf wider: Der Code sollte das ursprüngliche Design widerspiegeln. Dadurch wird sichergestellt, dass die Implementierung der Architektur entspricht und die geplanten Strukturen und Beziehungen im Code klar und verständlich erkennbar sind.

Praktiken:

• Test First (Test Driven Development): Tests werden vor der Implementierung geschrieben, um die Anforderungen und das Design klar und präzise zu definieren. Diese Methode stellt sicher, dass die Software von Anfang an den gewünschten Spezifikationen entspricht und fördert dadurch eine höhere Codequalität und Konsistenz.

6. Weißer Grad

Im weißen Grad werden alle Prinzipien des Clean Code Development vereint und in ihrer Gesamtheit angewendet.

Clean Coding ist mehr als nur eine Sammlung von Best Practices – es ist eine Philosophie, die die gesamte Entwicklungskultur positiv beeinflusst. Durch die Einhaltung der verschiedenen Grade und Prinzipien des Clean Code Development können Entwicklerinnen und Entwickler nicht nur die Qualität ihres Codes verbessern, sondern auch ihre Effizienz und Produktivität steigern. Die Reise hin zu sauberem Code mag herausfordernd sein, doch die Vorteile für die Softwareentwicklung sind enorm und langfristig unverzichtbar.