Namensgebung und Benennung

Die Benennung ist eine schlecht zu standardisierende Angelegenheit, da jeder seinen eigenen „Standard“ hat und man so nur Anhaltspunkte geben kann. Wichtig ist es aber, dass man in jedem Projekt, möglichst eine Form einhält.

Variablen

Die Variablen sollte man immer möglichst treffend benennen, denn aus Namen wie „wert“ oder „var“ kann man nur schlecht den Sinn herauslesen. Dazu muss man sich dann erst einmal den Code und den Kontext anschauen. Besser wäre es hier eine Variable „zaehler“ oder „ergebnis“ zu nennen.

Keine Regel ohne Ausnahmen. Einige Dinge sind historisch bedingt und gehören zum Vokabular eines guten Entwicklers. In den frühen Zeiten der Programmierung gab es Programmiersprachen (z.B. Fortran), die Variablen entsprechend ihres Anfangsbuchstabens entweder als Fließkommazahl oder Integer implizit deklarierten. Hier sind Variablen, die mit i, j, k, l, m, n beginnen implizit vom Typ Integer, alles andere sind Real (Fließkommazahl). Wer das anders wollte musste man Variablen explizit deklarieren. Daraus stammt noch der Fortran-Joke „God is real until declared integer“ und in nahezu jeder Programmiersprachen wird in Schleifen als erster Index nicht a verwendet, sondern i.

Es ist daher auch heute noch üblich, dass für Indizes oder kurz verwendete Variablen vom Typ Integer i, j, k, l, m und n verwendet werden und für alle anderen kurz verwendeten Fließkomma-Variablen kurze Variablennamen verwendet, wie x, y, z für Koordinaten oder a, b, c und x für ein Polynom wie f(x) = ax^2 + bx + c.

Funktionen und Methoden

Auch Funktionen sollte man möglichst treffend benennen, denn mit „mPtrCptClpbrd“ kann niemand etwas anfange und ein echter Zeitgewinn ist auch nicht. Besser wäre hier „MemoryPointerCopyToClipboard“, denn auch wenn der Variablenname länger ist, ist er einfacher zu verstehen.

Vor allem bei der Unterteilung von mehrere Wörtern in einem Variablen- oder Funktionsnamen scheiden sich die Geister, denn einige nutzen „_“ dafür, andere schreiben den ersten Buchstaben groß. Die zweite Schreibweise nennt sich CamelCase (entsprechend der Höcker beim Kamel) und sollte bevorzugt werden, da der Unterstrich bei einigen Sprachen auch als Operator gilt.

int eine_sehr_lange_variable;
int auchEineSehrLangeVariable;

Auch hängen einige ein „_s“ oder „_t“ an den Namen eines Structs oder typedef, um dies als ein solches zu erkenne zu geben. Gelegentlich sieht man einen Unterstrich vor Membervariablen von Strukturen oder Klassen.

struct Auto_s
{
  char const   * _Hersteller;
  char const   * _Modell;
  unsigned int   _PS;
};
 
typedef struct Auto_s Auto_t;