Was ein Name leistet

Code wird ungefähr zehnmal öfter gelesen als geschrieben — und meistens von jemandem, der den Zusammenhang nicht mehr im Kopf hat. Oft bist das du selbst, drei Monate später.

Namen sind das einzige Mittel, mit dem der Code seinem Leser etwas erklären kann, ohne dass jemand einen Kommentar pflegen muss. Sieh dir an, was das ausmacht:

public List<int[]> GetThem()
{
    var list1 = new List<int[]>();
    foreach (var x in theList)
        if (x[0] == 4)
            list1.Add(x);
    return list1;
}

Das ist syntaktisch tadellos und vollständig unverständlich. Nicht wegen der Komplexität — die Methode hat vier Zeilen — sondern weil kein einziger Name etwas verrät.

Die Fragen, die offenbleiben: Was steht in theList? Was bedeutet Index 0? Was bedeutet der Wert 4? Was tut der Aufrufer mit dem Ergebnis?

Dieselbe Methode, mit demselben Ablauf und derselben Anzahl Zeilen:

public List<Zelle> HoleMarkierteZellen()
{
    var markierte = new List<Zelle>();
    foreach (var zelle in _spielfeld)
        if (zelle.IstMarkiert)
            markierte.Add(zelle);
    return markierte;
}

Magische Zahlen sind Namen, die fehlen

Der Wert 4 im ersten Beispiel war eine magische Zahl: ein Literal, dessen Bedeutung nur im Kopf des Autors existiert. Sie sind besonders teuer, weil sie sich vermehren.

if (versuche > 3)
    Sperren(konto);

// … 200 Zeilen weiter …

if (fehlversuche >= 3)
    _logger.LogWarning("Konto gefährdet");

// Welche 3 gehört zu welcher Regel?

private const int MaxFehlversuche = 3;

if (versuche > MaxFehlversuche)
    Sperren(konto);

if (fehlversuche >= MaxFehlversuche)
    _logger.LogWarning("Konto gefährdet");

// Eine Regel, eine Stelle.

Die Länge eines Namens

Es gibt eine brauchbare Faustregel: Ein Name darf so lang sein, wie sein Gültigkeitsbereich gross ist.

• Der Laufindex einer dreizeiligen Schleife darf i heissen. Alles ist sichtbar.
• Eine lokale Variable in einer Methode braucht ein Wort: markierte, summe.
• Ein privates Feld braucht ein bis zwei: _offeneRechnungen.
• Eine öffentliche Klasse in einer Bibliothek darf ruhig MehrwertsteuerBerechnung heissen — sie wird an Stellen gelesen, die von ihrem Zuhause nichts wissen.

Umgekehrt heisst das: Ein kurzer Name in einem grossen Gültigkeitsbereich ist ein Fehler, und ein sehr langer Name in einer kurzen Methode ist meist ein Hinweis darauf, dass die Methode zu viel tut.