Bezeichner benennen: nach Rolle, im Fachvokabular, so lang wie die Reichweite

Ziel

Eine Leserin versteht Funktion oder Variable aus dem Namen, ohne den Rumpf zu lesen, und eine Suche nach einem Begriff findet genau dessen Verwendungen.

Voraussetzungen

Ein gemeinsames Vokabular des Fachgebiets (Glossar im README oder in Entscheidungsprotokollen); ein Werkzeug, das projektweit sicher umbenennt; die Namenskonvention der Sprache – PEP 8 für Python, «Effective Go» für Go – als gesetzt.

Schritte

1. Nach Rolle und Bedeutung benennen, nicht nach Typ oder Mechanismus: mahnfrist statt dt2, offene_rechnungen statt liste1, nach_kundin_gruppiert statt dict_result.
2. Länge nach Reichweite: Ein Schleifenindex darf i heissen, eine Modulkonstante oder eine öffentliche Funktion braucht die volle Beschreibung. Effective Go hält fest, dass lange Namen nicht automatisch lesbarer machen und ein guter Doc-Kommentar oft mehr wert ist als ein sehr langer Name.
3. Ein Wort pro Begriff im ganzen Projekt: laden oder holen oder lesen, nicht alle drei; die Begriffe des Fachgebiets verwenden, nicht die des Frameworks.
4. Wahrheitswerte als Aussage (ist_abgelaufen, hat_kinder), Funktionen als Verb oder Verbphrase (berechne_total, sende_erinnerung), Sammlungen im Plural, Einheiten im Namen, wo der Typ sie nicht trägt (timeout_ms, betrag_rappen).
5. Kodierungen vermeiden: keine Typpräfixe, keine Suffixe wie _v2 oder _neu, die nach der nächsten Änderung lügen. PEP 8 verbietet die Einzelzeichen l, O und I als Variablennamen, weil sie in manchen Schriften von 1 und 0 nicht zu unterscheiden sind.
6. Sprachkonventionen für Sichtbarkeit und Form einhalten: In Go entscheidet der Grossbuchstabe am Anfang über den Export, und Schnittstellen mit einer Methode enden per Konvention auf -er (Reader, Writer); in Python trennen Unterstriche Wörter, und ein führender Unterstrich markiert Internes.
7. Braucht ein Name einen Kommentar, um verstanden zu werden, umbenennen statt kommentieren. Verbessert sich das Verständnis, sofort umbenennen – mit Werkzeug, in einem eigenen Commit ohne andere Änderungen.

Erwartetes Ergebnis

Weniger Kommentare, kürzere Reviews, Suchen, die genau die Verwendungen eines Begriffs finden, und Code, in dem Fachpersonen ihre Begriffe wiedererkennen.

Grenzen und Prüfbasis

Öffentliche API-Namen lassen sich nicht frei ändern; sie verdienen beim ersten Mal mehr Sorgfalt. Deutsche oder englische Bezeichner sind eine Teamentscheidung, die konsequent gelten muss; Mischformen (getKundin) sind das Schlechteste von beidem. Die Konventionen stammen aus den zitierten Stilrichtlinien; eine Messung wird nicht behauptet.