« Mantis in Eclipse Wie bekomme ich meine Unittests grün ? »

Das richtige Bennenen von Variablen

2009 27 September

Auch wenn es trivial klingt so ist doch die richtige Bennung von Variablen ein sehr wichtige Sache, um Code über längere Zeit sauber und klar zu halten. Denn auch hier gilt der Grundsatz von Lao Tse "Verhüte das Große solange es noch klein ist". Wir alle haben schon Code gesehen, der Anfangs eigentlich noch ganz in Ordnung war und bei jedem zusätzlich Feature oder ChangeRequest immer ein Schritt unleserlicher wurde bishin zu kaum noch wartbarem Code.
Aus diesem Grund habe ich hier die meiner Meinung nach wichtigsten Punkte zusammengestellt die bei der richtigen Wahl des Variablennamens helfen sollen:

  • Die Variable soll genau beschreiben wofür sie steht.
  • Aus dem Namen soll klar werden, warum sie existiert, wofür sie verwendet wird und wie sie benutzt wird.
    Variablen die einen Kommentar benötigen sind sind auf jeden Fall zu verermeinden
    $d oder $count // Tage seit Beginn
    Sinnvollerwäre es hier die Variable:
    $daysSinceBeginn
  • Verweist der Name auf ein Sachverhalt „aus dem wirklichen Leben“ statt sich an Details der Programmiersprache anzulehnen
  • Eine Variablen soll im Kontext Sinn ergeben also eher $members als $array heißen.
  • Sind temporäre Variablen sinnvoll benannt. Da innerhalb von Methoden alle Variablen temporär sind hilft es niemandem Variablen einfach nur $temp o.ä zu nennen.
  • Ist klar wann boolsche Variablen den Wert true haben.
  • Nicht
    $status = true
    sondern
    $isAktiv = true
  • Abkürzungen vermeiden
  • Wer soll schon wisssen, dass $dsb für $daysSinceBeginn steht.
  • Verweisen Konstanten eher auf abstrakte Sachverhalte als auf Zahlen für die sie stehen
  • Also es soll eher
    Const MAX_NUMMER_OF_ITEMS = 7 
    heißen als
    Const SEVEN =  7
    was in diesem Fall gleich käme mit überhaupt keine Konstante zu verwenden sondern die Zahl direkt.

Wer mehr Interesse an diesem Thema hat dem empfehle ich folgende zwei Bücher aus denen ich die meisten Punkte übernommen habe: CleanCode und CodeComplete


Bearbeiten
Feed für diesen Eintrag

0 Antworten über Das richtige Bennenen von Variablen

    Bisher gibt es keine Kommentare.

Deine Angaben

Die Email Addresse wird nicht veröffentlicht

Dein Kommentar

Torsten Zander


 RSS Feed abonnieren

Twitter  Auf Twitter folgen

Posts

Blogrolls