Code-Konventionen sind vereinbarte Regeln dafür, wie Code geschrieben wird: wie Variablen und Klassen heißen, wie eingerückt wird, wo Klammern stehen und wie Dateien aufgebaut sind. Sie sorgen dafür, dass Code im ganzen Projekt aussieht, als hätte ihn eine Person geschrieben.
- Code-Konventionen
Festgelegte Regeln für Benennung, Formatierung und Aufbau von Quellcode, die in einem Projekt oder einer Sprache gelten.
Beispiel: „Nach unseren Code-Konventionen beginnen Methoden, die einen Wahrheitswert liefern, mit is oder has.“Auch: Coding Conventions, Coding Standards oder Programmierrichtlinien.
Welche Code-Konventionen es gibt
Viele Sprachen haben einen anerkannten Standard. In PHP gilt der PER Coding Style, Nachfolger von PSR-12, in Python PEP 8, und für JavaScript gibt es verbreitete Regelwerke wie den Airbnb Style Guide. Frameworks ergänzen eigene Regeln, Laravel etwa zu Namen von Controllern und Tabellen.
Dazu kommen Vereinbarungen im Team, die kein Standard regelt, etwa in welcher Sprache Variablen heißen oder wie Commits beschrieben werden.
Wie Werkzeuge Code-Konventionen durchsetzen
Formatierer wie Prettier oder Laravel Pint bringen den Code automatisch in die vereinbarte Form, Linter melden, was gegen die Regeln verstößt. Laufen sie bei jedem Commit oder in der Pipeline, muss niemand mehr darüber diskutieren.
In diesem Projekt läuft vor jedem Commit ein Prüfbefehl, der den Code mit Pint auf die Formatregeln von Laravel prüft, bevor statische Analyse und Tests folgen.
Warum sich Code-Konventionen lohnen
Weil Code viel häufiger gelesen als geschrieben wird. Einheitlicher Code liest sich schneller, Änderungen sind im Code Review leichter zu erkennen, und neue Leute finden sich schneller zurecht. Auch KI-Assistenten halten sich an Konventionen, die im Projekt sichtbar sind.