Règle
Utilisation descriptif noms de .
Très courts noms de variables noms rendent code peu clair.

Langues prises en charge : 45+

Introduction

Les noms de variables à une seule lettre ou cryptiques forcent les lecteurs à déduire le sens du contexte au lieu de comprendre le code d'un coup d'œil. Une variable nommée d pourrait représenter une date, une durée, une distance ou des données, exigeant un effort mental pour suivre son objectif tout au long de la fonction. Des noms descriptifs comme userCreatedDate ou requestDuration rendre l'intention immédiatement claire sans surcharge cognitive.

Pourquoi c'est important

Maintenabilité du code : Les noms de variables peu clairs ralentissent la compréhension. Les développeurs passent du temps à déterminer ce que représentent x, tmp ou val au lieu de se concentrer sur la logique réelle. Une mauvaise nomenclature rend également le code plus difficile à étendre car il n'est pas clair où la nouvelle logique devrait s'intégrer ou comment les valeurs existantes sont liées les unes aux autres. De plus, les noms vagues rendent la base de code non interrogeable, car la recherche de tmp ou val ne donne aucun résultat significatif. Cela s'aggrave lors du retour au code des mois plus tard ou lorsque de nouveaux membres rejoignent l'équipe.

Introduction de bugs : Les noms ambigus augmentent le risque d'utiliser la mauvaise variable. Lorsque plusieurs variables ont des noms cryptiques similaires (d1, d2, d3), les développeurs pourraient utiliser le mauvais, introduisant des bugs subtils qui passent la revue de code car les noms ne fournissent aucune indication sémantique.

Exemples de code

❌ Non conforme :

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;
}

Pourquoi c'est inexact : Noms de variables tels que u, p, d, t, et 'a' ne révèlent rien de leur objectif. Les lecteurs doivent analyser la logique de calcul pour comprendre que p est le prix, d est la remise, t est le sous-total, et a est le montant avant taxes.

✅ Conforme :

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;
}

Pourquoi c'est important : Chaque nom de variable décrit ce qu'il contient. amountAfterDiscount indique clairement l'état du calcul, taxe est sans ambiguïté, et produit et quantité révéler les entrées de la fonction sans avoir besoin de lire le corps.

Conclusion

Utilisez des noms qui révèlent l'intention sans nécessiter de contexte. Privilégiez la clarté à la concision. Les caractères supplémentaires dans totalPrice versus tp ne coûtent rien à l'exécution mais font gagner un temps considérable en compréhension.