Sa

16

Feb

2013

Programmier-Konventionen: Namensgebung

Wichtig ist bei der Benennung von Variablen, Funkionen, Methode, Klassen usw., dass man ein einheitliches Schema einhält. Nachfolgend wird ein mögliches Schema vorgestellt.

Grundsätzlich
Alles was man selbst benennen kann sollte man so sinnvoll wie möglich benennen. Das heisst einerseits, dass der Namen sofort klar macht, um was es sich handelt. Deshalb beginnen Methoden sehr oft mit "set" oder "get". Andererseits soll der Namen eine sinnvolle Länge besitzen.
Die Namen werden in Englisch geschrieben, alles andere macht nicht viel Sinn.

Klassen
Wenn ausschliesslich objektorientiert programmiert wird, werden Klassen in der Regel nicht mit "Camel Caps" (Beispiel: designTemplate), sondern unter Verwendung von Underscores (_) und Grossbuchstaben am Wortanfang benannt. Dabei sollte auf die Dateistruktur eingegangen werden.
Beispiel: Klasse in Datei "/database/table.php" wird "Database_Table" benannt.

Funktionen, Methoden und Variablen
Funktionen, Methoden und Variablen beginnen mit Kleinbuchstaben und werden unter Verwendung von "Camel Caps" benannt. Der Name soll soll genau aufzeigen, welche Aufgabe die Funktion/Methode hat, bzw. wozu die Variable verwendet wird. Die Verwendung von Zahlen ist im Normalfall irreführend und deshalb zu vermeiden.
Als Zählvariable in Loops (Schlaufen) werden einzelne Buchstaben gewählt. Standardbenennung ist $i, wird eine weitere Zählvariable benötigt wird in der Regel $n verwendet. Eine andere Möglichkeit wäre, dem Alphabet gemäss weiterzufahren, wobei $l wegen Verwechslungsgefahr ausgelassen wird. ($i, $k, $m, $n ...)

Konstanten
Konstanten werden ausschliesslich mit Grossbuchstaben benannt. Um die Lesbarkeit zu erleichtern können Underscores (_) zwischen Wörtern verwendet werden.

Kommentar schreiben

Kommentare: 0