Regola
Utilizzo variabili variabile .
Molto corte variabili nomi rendono il codice poco chiaro.
Linguaggi supportati: 45+Introduzione
I nomi delle variabili composti da una sola lettera o criptici costringono i lettori a dedurne il significato dal contesto, invece di comprendere il codice a prima vista. Una variabile denominata d potrebbe indicare una data, una durata, una distanza o dei dati, richiedendo uno sforzo mentale per comprenderne lo scopo nel corso della funzione. Nomi descrittivi come dataCreazioneUtente oppure durata della richiesta rendere immediatamente chiaro l'intento senza alcuno sforzo cognitivo.
Perché è importante
Manutenibilità del codice: i nomi delle variabili poco chiari rallentano la comprensione. Gli sviluppatori impiegano tempo a capire cosa rappresentino x, tmp o val, invece di concentrarsi sulla logica vera e propria. Una denominazione inadeguata rende inoltre più difficile l’estensione del codice, poiché non è chiaro dove inserire la nuova logica o come i valori esistenti siano correlati tra loro. Inoltre, i nomi vaghi rendono il codice non ricercabile, dato che la ricerca di “tmp” o “val” non fornisce risultati significativi. Questo problema si aggrava quando si riprende a lavorare sul codice dopo mesi o quando entrano a far parte del team nuovi membri.
Descrizione del bug: I nomi ambigui aumentano il rischio di utilizzare la variabile sbagliata. Quando più variabili hanno nomi simili e poco chiari (d1, d2, d3), gli sviluppatori potrebbero utilizzare quello sbagliato, introducendo bug impercettibili che superano la revisione del codice poiché i nomi non forniscono alcun indizio semantico.
Esempi di codice
❌ 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;
}
Perché è inesatto: Nomi di variabili come u, p, d, t, e non rivelano nulla sul loro scopo. I lettori devono seguire la logica di calcolo per capire che p è il prezzo, d è uno sconto, t è il subtotale, e a è l'importo al lordo delle imposte.
✅ 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;
}
Perché è importante: Il nome di ogni variabile descrive il suo contenuto. importoDopoSconto indica chiaramente lo stato del calcolo, imposta è inequivocabile, e prodotto e quantità rivelare gli argomenti della funzione senza dover leggere il corpo della stessa.
Conclusione
Utilizzate nomi che rivelino l’intento senza richiedere un contesto. Privilegiate la chiarezza rispetto alla brevità. I caratteri in più in prezzo totale rispetto a tp non comportano alcun costo in termini di esecuzione, ma consentono di risparmiare molto tempo nella comprensione.
