Variablen richtig benennen

Mit eine vernünftigen Benennung von Klassen, Funktionen und Variablen erreichen Sie eine deutlich höhere Lesbarkeit und Verständlichkeit Ihres Codes. Dieser Beitrag zeigt, worauf Sie beim Programmieren achten müssen, um möglichst gut lesbaren Code zu erhalten.

In vielen Programmen sieht der Quellcode so aus:

$a = ‘Hallo Welt’;

// 1000 Codezeilen

echo $a;

?>

Das funktioniert einwandfrei. Was passiert aber, wenn wirklich 1.000 Zeilen Code zwischen der Zuweisung des Wertes und der Ausgabe der Variable stehen? Dann wissen Sie nicht mehr, welche Ausgabe Sie von $a zu erwarten haben. Und ein anderer Programmierer, der Ihren Code überarbeiten möchte, weiß schon erst recht nicht, was Sache ist.

Oder was, wenn sich die Zuweisung von Variablen und deren Ausgabe über mehrere Include-Dateien verteilen? Dann sind Fehler programmiert. Und die sind schwer zu finden. Sie ersparen sich eine Menge Ärger, wenn Sie aussagekräftige Variablennamen wählen, zum Beispiel:

$strGreeting = ‘Hallo Erde’;

// 1000 Codezeilen

echo $strGreeting;

?>

Hier verrät der Variablenname auch 1.000 Zeilen später noch eine Menge:

Nämlich, dass es sich beim Inhalt um eine Zeichenkette (string) handelt und dass sie einen Begrüßungstext enthält. Natürlich können Sie auch deutschsprachige Bezeichnungen wählen, also $strBegruessung Vermeiden Sie dabei aber Umlaute. Denn sobald Sie den Code von einer anderen Betriebssystem-Plattform aus bearbeiten, sind statt der Umlaute nur noch kryptische Zeichen zu sehen.

Für PHP könnten Sie folgende Präfixes vor den Variablennamen stellen:

$intXXX – Ganzzahlen

$floatXXX oder $doubleXXX- Gleitkommazahlen

$arrXXX – Array

$boolXXX – Boolsches ‘true’ oder ‘false’

$objXXX – Objekt

oder Sie verwenden kurze Bezeichner:

$iXXX – Ganzzahlen

$fXXX oder $doubleXXX- Gleitkommazahlen

$aXXX – Array

$bXXX – Boolsches ‘true’ oder ‘false’

$oXXX – Objekt

Wichtig ist nur, dass Sie eine Schreibweise durchhalten – nicht nur in einer Datei, sondern im ganzen Projekt und möglichst auch in den Folgeprojekten.

Am besten dokumentieren Sie an zentraler Stelle, welche Schreibweise Sie

für Ihre Variablen vorgeben.

Die richtigen Namen finden

In der Regel bestehen Namen von Variablen oder Funktionen aus mehreren

Wörtern. Schreiben Sie diese Wörter zusammen und beginnen Sie jedes neue

Wort groß, zum Beispiel function getObjectData()

Ob Sie den ersten Buchstaben groß oder klein schreiben, bleibt Ihnen überlassen – das ist Geschmackssache. Bei Variablennamen in PHP sieht die Kleinschreibung besser aus, also

$intLevel = 0;

statt

$IntLevel = 0;

Beachten Sie, dass für PHP die unterschiedliche Schreibweise wichtig ist. $intLevel und $IntLevel sind für PHP zwei unterschiedliche Variablen.

Nun gilt es, geeignete Namen für die Variablen und Funktionen zu finden. Klassen und daraus abgeleitete Objekte benennen Sie mit Substantiven:

class classText

oder

$objText = new classText();

Methoden oder Funktionen lassen sich meist mit einer Kombination aus Verb

und Substantiv gut beschreiben, zum Beispiel

function readText()

Um einen Namen zu finden, überlegen Sie einfach “Was passiert womit?”. Das “was” ist in dem Fall das “read”. Und das “womit” ist “Text”. Bleibt die Frage: Was bedeutet “read”? Heißt das, die Funktion liest Daten ein oder bedeutet es, dass der Betrachter der Seite einen Text ansehen darf? Im Normalfall tippt man auf die erste Variante. Aber der Eindeutigkeit halber nennen Sie die Funktion function readTextFromDb()

Falls Sie eine Methode benennen, verzichten Sie auf das “womit”. Denn dabei handelt es sich ja um das Objekt, also $objText->readFromDb();

Bleiben noch die Bezeichnungen von Variablen und Eigenschaften. Dafür

verwenden Sie am besten Substantive,etwa

$strName = ‘Muster’;

Ungarische Notation

Die Methode, vor den eigentlichen Variablennamen einen Hinweis auf den Datentyp zu stellen heißt “Ungarische Notation”. “Ungarisch”, weil diese Art, Variablen zu bezeichnen von einem gebürtigen Ungarn namens Simonyi stammt.

Diese Schreibweise von Variablen ist umstritten. Für typisierte Sprachen wie Java oder C# empfehlen einschlägige Lehrbücher, diese Schreibweise nicht zu verwenden. In nicht streng typisierten Sprachen wie PHP lohnt sich die Ungarische Notation allerdings. Denn sie gibt einen Hinweis auf den erwarteten Variablentyp und kann in vielen Fällen falsche Zuweisungen verhindern oder beim Debugging helfen.

Sprache für Variablen

Beim Benennen von Variablen, Klassen oder Methoden haben Sie die freie Wahl. Sie können englische Bezeichner wählen oder deutschsprachige. Wichtig ist nur, dass Sie eine Sprache durchhalten.

Zu empfehlen sind Bezeichner in Englisch. Denn so können später einmal andere Programmierer an Ihrem Projekt mitarbeiten, auch wenn sie nicht Deutsch sprechen.

Ähnliche Beiträge