Sprechender Variablenname

Ein sprechender Variablenname – genauer auch selbsterklärender Variablenname – ist ein Bezeichner für eine Variable, aus dem die Bedeutung der Variable sichtbar wird. Dies gilt nicht nur für Variablen, sondern auch für Klassen, Methoden, Funktionen und Ähnliches.

Auch wenn Quellcode (oder Quelltext) für die Maschine lesbar sein muss und es dieser vollkommen egal ist, wie die Variablen heißen, so wird Code dennoch von Menschen entworfen und gepflegt. Gerade wenn man als Team an einem Projekt arbeitet, ist ein gut kommentierter, also menschenlesbarer Code wichtig. In der heutigen Zeit ist es nicht mehr notwendig, durch die Verkürzung der Bezeichner informatischer Elemente Speicherplatz zu sparen oder auf eine schnellere Programmausführung hinzuarbeiten. Für die Überführung in das Produktivsystem können die Quelltexte zum Beispiel durch die Entfernung von Kommentaren, Leerzeichen (englisch whitespaces) und auch durch kürzere Bezeichner optimiert werden. Für Menschen ist derartiger Code dann aber nur noch sehr schwer les- und nachvollziehbar.

Quelltexte oder Programmcodes werden durch die Vermeidung sprechender Variablennamen unleserlich und damit fehleranfälliger sowie schwerer wartbar. Auch die Entwicklung neuer Versionen wird damit erschwert.

Empfehlung: Verwenden Sie sprechende Variablennamen und halten Sie sich an bestehende Konventionen.

Bestehende Konventionen

• i, j: Zählvariablen in Schleifen
• für einfache(!) mathematische Berechnungen werden in der Regel dieselben Variablenbezeichner wie in der Schule verwendet, z. B. r für Radius, a und b für Seitenlängen

Beispiele

• error_nr
• einzelpreis
• mwst_satz
• mwst_satz_reduziert

Das Finden passender Bezeichnungen ist dabei eine schwierige Aufgabe.

There are only two hard things in Computer Science: cache invalidation and naming things. -- Phil Karlton

Weblinks

• German Naming Convention sehr gute und humorige Erklärung, warum man sprechende Variablennamen verwenden sollte.

Siehe auch

• Sprechender Link