Warum ist Codequalität für Entwickler so wichtig?

Codequalität kann sich darauf auswirken, wie nützlich und wartbar Ihr Code ist: Hochwertiger Code kann wiederverwendet und neu entwickelt werden.

Projekte sind oft ein Wettlauf gegen die Uhr und das Budget ist so knapp, dass es eine Chimäre ist, auf ein paar Hände mehr zu zählen, um Code zu schreiben. Ecken zu schneiden scheint der einfache Ausweg zu sein, aber es wird sich auf lange Sicht nicht auszahlen.

Gut strukturierter Code, der Sprachregeln folgt, ist für verschiedene Browser und andere Entwickler viel einfacher zu lesen und zu verstehen. Es ist auch zuverlässiger und vermeidet zukünftige Nacharbeiten.

Softwareprojekte können in verschiedenen Phasen (von Anforderungen über Analyse, Entwicklung, Test, Bereitstellung und Wartung) unterschiedlichen Einschränkungen unterliegen, die manchmal dazu führen können, dass der Code selbst als der am wenigsten wichtige Aspekt behandelt wird (Funktion über Form). Eine der wichtigsten — und oft vergessenen – Eigenschaften guter Software ist jedoch die Codequalität.

Die Codequalität kann auf verschiedene Arten gemessen werden, aber einige der wichtigsten Aspekte sind:

• Lesbarkeit, Konsistenz – wie einfach es ist, Abschnitte des Codes zu lesen und zu verstehen; Dazu gehören Klarheit, Einfachheit und Dokumentation des Codes.
• Vorhersagbarkeit, Zuverlässigkeit und Robustheit — Das Softwareverhalten sollte vorhersehbar und nicht anfällig für versteckte Fehler sein.
• Wartbarkeit und Erweiterbarkeit — Das Reparieren, Aktualisieren und Verbessern von Software sollte so einfach wie möglich und nicht inhärent komplex sein.

Warum ist Codequalität wirklich wichtig?

Warum sollte angesichts der üblichen Einschränkungen, die bereits in der Softwareentwicklung bestehen, der Aufwand für die Erstellung von Qualitätscode so wichtig sein?

Das Schreiben von Qualitätscode sollte nicht als zeitaufwändige Aufgabe angesehen werden, sondern als eines der Hauptziele bei der Entwicklung von Software; Es sollte als eine wesentliche Investition betrachtet werden, auf die fast sofort eine Rendite folgt:

• Code, der gut lesbar, konsistent und dokumentiert ist, ist einfacher zu überprüfen, was zu einem viel geringeren Entwicklungsaufwand führt.
• Sauberer und eleganter Code ist auch viel einfacher zu verstehen, zu pflegen und zu erweitern.
• Software, die gut gestaltet ist und eine geringere Codekomplexität erreicht, profitiert auch in Bezug auf Testbarkeit und Robustheit (weniger anfällig für neue Fehler).

Im Wesentlichen ist eine hohe Codequalität eine der effektivsten Möglichkeiten, die technische Verschuldung zu senken.

Lassen Sie mich Ihnen ein Beispiel zeigen

Code von schlechter Qualität kann normalerweise verursacht werden durch:

• Fehlende (oder unzureichende) Codierungsstile / -standards.
• Keine / schlechte Dokumentation.
• Schlecht gestaltete Architektur (ohne Trennung der Verantwortlichkeiten, wie in MVC).
• Hohe Methodenkomplexität

Im folgenden Beispiel kann der Zweck der Methode ohne sorgfältige Prüfung nicht eindeutig identifiziert werden:

• Es gibt keine Funktionsdokumentation, keine Kommentarzeilen und es wird kein offensichtlicher Codierungsstandard befolgt (z. B. bei der Verwendung von geschweiften Klammern und Leerzeilen).
• Die Komplexität ist aufgrund der Anzahl verschiedener Aktionen und Prozesse (DB-Abfragen, Ansicht / Ausgabe und Geschäftslogik) und mehrerer Verschachtelungsebenen relativ hoch.
• Es gibt eine Inkonsistenz in den Methoden zur Ausgabe und Variableninterpolation.

Aufgrund seiner geringen Qualität ist der Code anfällig für Fehler / Bugs (ganz zu schweigen von Sicherheitsbedenken) und schwer richtig zu testen.

Darüber hinaus werden Änderungen an der Software wahrscheinlich zu einem erhöhten Entwicklungs- und Testaufwand führen und immer noch dazu führen, dass potenzielle neue Fehler eingeführt werden.

Auf der anderen Seite ist das Befolgen eines Codierungsstandards und das Dokumentieren von Code ein Schlüsselaspekt der Qualität.

Ein zufälliges Beispiel dafür ist im folgenden Bild zu sehen, einem Abschnitt des FrameworkBundle-Controllers von Symfony.php:

Neben der Methoden- / Parameterdokumentation können wir das deutlich sehen:

• Der Code ist einfach und selbsterklärend.
• Verschiedene Logikabschnitte werden durch Leerzeilen getrennt.
• Es gibt nur wenige Verschachtelungs- / Einrückungsebenen mit frühen return-Anweisungen.
• Es gibt richtige Designüberlegungen (Trennung der Verantwortlichkeiten nach verschiedenen Objekten / Klassen).
• Aufgrund der hohen Codequalität und Übersichtlichkeit sollte die Klasse / Methode mit geringem Aufwand einfach zu testen und zu warten sein; die Wahrscheinlichkeit des Auftretens von Fehlern sollte ebenfalls äußerst gering sein.

Wie kann eine hohe Codequalität erreicht werden?

Hier ein paar Tipps:

• Auswahl eines geeigneten Codierungsstandards (Stils) für die Sprache oder das Framework. Für PHP kann beispielsweise PSR-2 als aktuelle Standardempfehlung angesehen werden. Es kann möglich sein, CS Fixer-Tools in Ihre Entwicklungsumgebung zu integrieren (siehe php-cs-fixer)
• Konsistenz in Klassen-, Methoden- und Variablennamen ist ein weiterer wichtiger Faktor für die Lesbarkeit.
• Sicherstellen, dass Klassen, Eigenschaften, Methoden und bestimmte Codeblöcke bei Bedarf ordnungsgemäß dokumentiert werden, um sicherzustellen, dass Kommentare einfach, präzise und effektiv sind.
• Das Refactoring und die Auswahl korrekter Entwurfsmuster ist ein guter Weg, um die Wiederverwendbarkeit und Erweiterbarkeit von Code zu fördern und eine geringere Klassen- / Methodenkomplexität zu erreichen.
• Hinzufügen von Codeanalysetools zur CI-Umgebung, die vor dem Zusammenführen neuer Änderungen ausgeführt werden sollen. Für PHP sind phpmd und / oder phpstan Tools, die vor möglichen Problemen im Code warnen können und eine Reihe verschiedener konfigurierbarer Regeln haben.
• Automatisiertes Testen ist ein weiteres Muss; Es hilft nicht nur, neue Fehler zu vermeiden, sondern auch sicherzustellen, dass es die Anforderungen erfüllt und korrekt auf verschiedene Eingaben reagiert.
• Schließlich sollten Tools wie Scrutinizer-ci und Codacy eingesetzt werden, um einen klaren Überblick über die Qualität eines Projekts im Zeitverlauf und wichtige Details darüber, was und wo die Probleme liegen, zu testen und anzuzeigen.

Fazit

Unabhängig von Entwicklungsmethoden, Sprachen, Frameworks oder Tools ist die Durchsetzung einer hohen Codequalität ein Weg, um eine schnellere und einfachere Entwicklung, Prüfung und Wartung zu erreichen, was zu reduzierten Kosten für den Softwarebesitz führt.

Geschrieben von João Inácio / Senior Developer und Teamleiter bei Cleverti

Dieser Artikel wurde ursprünglich auf Clevertis Blog veröffentlicht