August 11, 2011 0

Variablen richtig benennen

By in Best practice, C#, Designpattern, JAVA, JavaScript, PHP, VB.NET

Sie kennen das bestimmt: Sie lesen sich den Quellcode eines anderen Entwicklers durch und verstehen erst einmal nur Bahnhof. Zwar ist der Code kommentiert und die Struktur ist auch nachvollziehbar aber trotzdem kommen Sie irgendwie nicht so richtig zurecht oder es dauert einfach zu lange, bis Sie richtig „durchgestiegen“ sind.
Schuld daran ist nicht zuletzt eine schlechte Wahl der Variablennamen.

Namenskonventionen gibt es schon wie Sand am Meer, trotzdem möchte ich an dieser Stelle meinen Ansatz vorstellen der sich in vielen Projekten bewährt hat:

1. Regel: Aussagekräftige Namen

Benennen Sie Ihre Variablen So, dass Sie oder jeder andere Entwickler sofort weiß, worum es geht.
Dies bedeutet auch: Verwenden Sie englische Bezeichnungen.
Geizen Sie außerdem nicht mit der Länge: Die Zeiten von „platzsparender Programmierung“ ist – zumindest in diesem Bereich – passé!
Verwenden Sie nach Möglichkeiten keine Abkürzungen, es sei denn sie tauchen sehr häufig auch an anderer Stelle in Ihrem Code auf.

2. Regel: Verwenden Sie Präfixe

Auch in modernen objektorientierten Sprachen wie VB.NET, C# oder JAVA wird immer noch auf Standarddatentypen zurück gegriffen.
Für diese Verwende ich die folgenden Präfixe:

  • String: str
  • Zahl (Integer, single, double…): num
  • Boolean: bol

Also z.B. strExampleVariable
Neben diesen Standarddatentypen erhalten auch die Objekte ein Präfix:

  • Objekt obj

Anmerkung: In Projekten in denen Auf Klassen und Objekte einer extern eingebundenen API oder Vergleichbaren verwiesen wird, kann es sinnvoll sein den Namen der API oder dessen Hersteller als Präfix zu nehmen:

z.B. Objekte des Herstellers NEVRON: nev

Auch hier werden genau drei Zeichen verwendet.

Es hat sich außerdem als sinnvoll erwiesen, einer bestimmten Objekt-Kategorie aufgrund ihrer häufigen Verwendung ein eigenes Präfix zu spendieren:

  • Listen, Hashtables oder Ähnliches: lst

3. Regel: Groß-und-Kleinschreibung

Da die Präfixe bei mir klein geschrieben sind, beginnt jeder Variablenname logischerweise mit einem Kleinbuchstaben. Neue Wörter im Variablennamen beginnen mit einem Großbuchstaben. Dies erhöht die Lesbarkeit:
z.B. lstRelevantPages statt lstreleveantpages
Besonders bei Programmiersprachen (wie z.B. Java oder PHP), die Groß-und-Kleinschreibung unterscheiden ist dieser Punkt wichtig!

4. Indizes und Schleifenzähler

Ein index ist eine einfach Zahl zur identifizierung eines Items. Mehr gibt es nicht zu erklären, warum also einen längeren Variablennamen verwenden? Hinzu kommt, dass die Verwendung (Scoping) auf die Schleife selbst begrenzt ist.
Für die Normale For-Schleife verwende ich einfache Buchstaben:

for (int i; i

(Mehrere verschachtelte For-Schleifen in JAVA)

for each o as Object in lstObjects
  o.save()
next

5. Deklarationen an den Anfang

Der Code wird sehr viel lesbarer, wenn man die Variablendeklarationen am Anfang des Code-Dokuments vorfindet. Oder finden Sie das hier etwa gut lesbar?

  Private Function test() As String
    Dim i As Integer = 4
    Dim variable As String = "bla"
    i = i + 3
    Dim result As Integer = i - 2
    return variable & result
  End Function

6. Ausnahmen

Die zweite Regel wende ich bei objektorientierten Sprachen nicht in den Funktionen bzw. Methoden an, sondern ausschließlich für “globale” Variablen. Wenn man sich an die goldende “Teile-Und-Herrsche”-Designregel hält und die Funktionen nicht zu umfangreich werden lässt, sind die Präfixe eher hinderlich.

Tags: , , , , , , ,

Leave a Reply