Lesbarer Code: Konventionen, sprechende Namen, Kommentare und das Prinzip der geringsten Überraschung
Code wird viel öfter gelesen als geschrieben. Dieser Artikel zeigt an der Kata der CSB-Rad GmbH, wie Du Code mit wenigen Handgriffen lesbar machst: einheitliche Schreibweisen nach den Konventionen für Java und Python (PEP 8), sprechende Namen statt Abkürzungen, benannte Konstanten und Aufzählungen statt magischer Zahlen, Kommentare, die das Warum erklären, und Methoden, die tun, was ihr Name verspricht (Prinzip der geringsten Überraschung, Command-Query-Separation). Zum Schluss geht es um Linter und Formatierer, die einen Teil dieser Regeln automatisch prüfen.