# Codequalität

## Was es ist

Codequalität beschreibt, wie zuverlässig Quellcode das beabsichtigte Verhalten liefert und wie gut
Menschen ihn verstehen, prüfen und ändern können. Nehmen wir eine Funktion für die
Rechnungsstellung. Eine Version liefert bei der Beispielbestellung den richtigen Betrag, weil sie
genau den beim Schreiben vorgesehenen Ablauf durchläuft. Eine zweite benennt die Währung, legt die
Rundungsregel an einer Stelle fest und behandelt Gutschriften ausdrücklich. Beide können einen
Test für den Normalfall bestehen. Wer eine strittige Rechnung untersucht, findet sich in der
zweiten Fassung schneller zurecht.

Zur Korrektheit gehören Grenzfälle wie ungültige Eingaben, ein Wiederholungsversuch oder ein
teilweise abgeschlossener Vorgang. Verständlichkeit zeigt sich daran, welche Entscheidungen die
nächste Person beim Lesen nachvollziehen kann. Änderbarkeit hängt davon ab, wie weit sich ein
neuer Wunsch im System auswirkt und ob sich die Folgen überprüfen lassen. Eine kurze Funktion kann
die falsche Steuer berechnen. Eine verwickelte Funktion kann heute korrekt sein und die nächste
Währungsumstellung schwer überprüfbar machen.

Ein Code-Review hilft, diese Eigenschaften an einer konkreten Änderung zu prüfen. Ein Quality Gate
hält Vorhaben auf, wenn festgelegte Prüfungen fehlschlagen. Technische Schulden bezeichnen
zukünftige Kosten, die aus einer Entscheidung entstehen. Codequalität meint den Zustand des Codes
selbst. Googles Review-Standard übersetzt das in eine alltägliche Frage. Verbessert die einzelne
Änderung den Zustand der Codebasis insgesamt?

## Warum es wichtig ist

Meist macht sich die Qualität bemerkbar, wenn eine Anforderung hinzukommt. Ein Dienst berechnet
Angebote, stellt Rechnungen und erstattet später Zahlungen. Wenn alle drei Vorgänge dieselbe
Rabattregel getrennt umsetzen, muss das Team für die nächste Aktion sämtliche Kopien finden. Eine
Abweichung wird womöglich erst bei der ersten Erstattung sichtbar. Eine gemeinsame Regel an einer
bekannten Stelle und klar benannte Eingaben für jeden Aufruf machen die Folgen einer Änderung
leichter abschätzbar.

Welche Belege nützen, hängt vom Risiko ab. Bei Geldbeträgen wählt man einen Fall, in dem die
Rundung einzelner Positionen ein anderes Ergebnis liefert als die Rundung der Summe. Bei einem
wiederholbaren Vorgang prüft man, ob die zweite Anfrage eine weitere Abbuchung auslöst. Läuft eine
Rechnung bei jedem Einkauf, lassen sich Ausführungszeit und erwartete Last messen, bevor man einen
Zwischenspeicher hinzufügt. Jede Beobachtung trägt eine Aussage mit bestimmter Reichweite.

Gute Qualität hilft auch bei der Übergabe. Menschen wechseln das Projekt und wer eine Änderung
liest, kennt die Vorgeschichte oft nicht. Aussagekräftige Namen, ein ausführbares Beispiel und
eine kurze Erklärung zu einer ungewöhnlichen Vorgabe helfen, eine Entscheidung selbstständig zu
prüfen. Diese Möglichkeit zählt bei der Fehlersuche am Wochenende ebenso wie bei der Einarbeitung.

## Wie es in der Praxis aussieht

Angenommen, ein Betrieb rundet den Steuerbetrag erst nach der Summierung je Steuersatz. Bei einer
Rechnung mit zwei Positionen entstehen ungerundet jeweils 0,005 Währungseinheiten Steuer. Rundet
man jede Position auf volle Cent und rundet dabei genau in der Mitte auf, ergibt sich insgesamt
0,02. Addiert man zuerst und rundet einmal, ergibt sich 0,01. Die Zahlen sind klein genug, um sie
im Kopf zu prüfen. Für eine echte Rechnung ergeben sich die Regeln aus den Produktanforderungen
und den geltenden Vorschriften.

Der Vertrag der Funktion kann Eingabeeinheiten und Rechenreihenfolge benennen. Die Darstellung der
Zwischenwerte muss die nötige Genauigkeit erhalten. Die Gruppierung nach Steuersätzen soll
erkennbar bleiben, die Rundung erfolgt an der vereinbarten Stelle. Ein Test mit den genannten
Beträgen unterscheidet die beiden Verfahren. Zusätzlich kann ein Test mit verschiedenen
Steuersätzen verhindern, dass bei einem Umbau alle Gruppen in einem Betrag landen. Für eine
abweichende Regel bei Gutschriften bietet sich ein eigenes Beispiel an.

Bei der Prüfung verfolgen wir den Betrag, den der Kunde sieht, den exportierten Wert und den
Aufruf bei einer Erstattung. Alte Rechnungen behalten die bei der Ausstellung erfassten Beträge.
Ein Test des vollständigen Ablaufs zeigt, ob die Aufrufe die richtigen Einheiten übergeben. Ein
isolierter Test gibt Auskunft über die Berechnung mit bestimmten Eingaben.

Unser [Artikel darüber, wie das letzte Ticket nur einmal verkauft
wird](/de/notes/selling-limited-stock-without-overselling/) wendet dieselbe Arbeitsweise auf
Bestände an. Er formuliert eine Gleichung, die stets gelten muss, beschreibt parallele Tests und
schlägt vor, die Gleichung im Betrieb zu überwachen. An ihr lässt sich bei der Änderung
verschiedener Abläufe ablesen, was erhalten bleiben muss.

## Wo es schiefgeht

Messbare Signale werden leicht mit Beweisen verwechselt. Die Testabdeckung zeigt, welche
Anweisungen oder Zweige ausgeführt wurden. Ein Test kann trotzdem eine unzutreffende Rundungsregel
als Sollwert festschreiben. Eine Komplexitätskennzahl weist auf prüfenswerten Code hin. Ersetzt
man einen klaren Vergleich durch mehrere schwer erklärbare Hilfsfunktionen, kann sich die
Fehlersuche dennoch verschlechtern. Vor einem neuen Grenzwert sollte das Team benennen, welchen
Fehler der Wert erkennen soll, und Fälle auf beiden Seiten prüfen.

Auch Aufräumen hat unterschiedliche Priorität. Ein unklarer Name in einem selten genutzten Bericht
hat eine andere Wirkung als eine mehrdeutige Bedingung bei jeder Zahlung. Dokumentieren Sie das
Risiko und trennen Sie notwendige Fehlerkorrekturen von optionalen Verbesserungen. Bei einer
Formatfrage helfen oft eine gemeinsame Regel und ein automatischer Formatierer.

Eine lokale Verbesserung kann das Problem verschieben. Ein gemeinsamer Rabattbaustein passt, wenn
mehrere Aufrufer tatsächlich dieselbe Regel brauchen. Er wird unübersichtlich, wenn er zwischen
unterschiedlichen Regeln für Verlängerungen, Werbeaktionen und Rückerstattungen raten muss.
Benennen Sie zunächst, welche Eingaben und Bedingungen übereinstimmen. Teilen Sie den stabilen
Teil und halten Sie die Unterschiede sichtbar. Eine andere Person sollte die Regel am Code
erklären und das Ergebnis prüfen können.

## Weiterführende Lektüre

- [Googles Maßstab für die Freigabe einer
  Codeänderung](https://google.github.io/eng-practices/review/reviewer/standard.html)
- [Worauf Google bei einem Code-Review
  achtet](https://google.github.io/eng-practices/review/reviewer/looking-for.html)
- [Unit-Tests in Software Engineering at
  Google](https://abseil.io/resources/swe-book/html/ch12.html)

<https://engineer.company/de/glossary/code-quality/>
