Regel
Verwendung beschreibend Variable .
Sehr kurze Variablennamen Namen machen den unübersichtlich.

Unterstützte Sprachen: 45+

Einleitung

Einbuchstabige oder kryptische Variablennamen zwingen Leser, die Bedeutung aus dem Kontext abzuleiten, anstatt den Code auf den ersten Blick zu verstehen. Eine Variable namens d könnte Datum, Dauer, Distanz oder Daten darstellen, was geistige Anstrengung erfordert, um seinen Zweck innerhalb der Funktion zu verfolgen. Beschreibende Namen wie userCreatedDate oder Anfragedauer Absicht sofort ohne kognitiven Aufwand klar machen.

Warum es wichtig ist

Code-Wartbarkeit: Unklare Variablennamen verlangsamen das Verständnis. Entwickelnde verbringen Zeit damit herauszufinden, was x, tmp oder val darstellen, anstatt sich auf die eigentliche Logik zu konzentrieren. Eine schlechte Benennung erschwert auch die Erweiterung des Codes, da unklar ist, wo neue Logik passen sollte oder wie bestehende Werte zueinander in Beziehung stehen. Darüber hinaus machen vage Namen die Codebasis unauffindbar, da die Suche nach tmp oder val keine aussagekräftigen Ergebnisse liefert. Dies verstärkt sich, wenn man Monate später zum Code zurückkehrt oder wenn neue Teammitglieder hinzukommen.

Fehlereinführung: Mehrdeutige Namen erhöhen die Wahrscheinlichkeit, die falsche Variable zu verwenden. Wenn mehrere Variablen ähnliche kryptische Namen haben (d1, d2, d3), Entwickelnde könnten das falsche verwenden, was zu subtilen Fehlern führt, die die Code-Überprüfung bestehen, da die Namen keine semantischen Hinweise liefern.

Code-Beispiele

❌ Nicht konform:

function calcAmt(u, qty) {
    const p = u.prc;
    const d = u.disc || 0;
    const t = p * qty;
    const a = t - (t * d);
    const tx = a * 0.08;
    return a + tx;
}

Warum es ungenau ist: Variablennamen wie u, p, d, t, und 'a' verraten nichts über ihren Zweck. Leser müssen die Berechnungslogik nachvollziehen, um zu verstehen, dass p ist der Preis, d ist der Rabatt, t ist die Zwischensumme, und a ist der Betrag vor Steuern.

✅ Konform:

function calculateOrderAmount(product, quantity) {
    const price = product.price;
    const discount = product.discount || 0;
    const subtotal = price * quantity;
    const amountAfterDiscount = subtotal - (subtotal * discount);
    const tax = amountAfterDiscount * 0.08;
    return amountAfterDiscount + tax;
}

Warum dies wichtig ist: Jeder Variablenname beschreibt, was er enthält. amountAfterDiscount zeigt klar den Berechnungsstatus an, Steuer ist eindeutig, und Produkt und Menge die Eingaben der Funktion offenlegen, ohne den Funktionsrumpf lesen zu müssen.

Fazit

Verwenden Sie Namen, die die Absicht ohne Kontext offenbaren. Bevorzugen Sie Klarheit gegenüber Kürze. Die zusätzlichen Zeichen in Gesamtpreis versus tp kosten in der Ausführung nichts, sparen aber erhebliche Zeit beim Verständnis.