Regra
Utilização descritivo nomes .
Muito curtos nomes de variáveis . tornam o código pouco claro.

Idiomas suportados: 45+

Introdução

Nomes de variáveis de uma única letra ou crípticos forçam os leitores a deduzir o significado do contexto, em vez de entender o código rapidamente. Uma variável chamada d poderia representar data, duração, distância ou dados, exigindo esforço mental para rastrear seu propósito ao longo da função. Nomes descritivos como userCreatedDate ou requestDuration deixar a intenção imediatamente clara sem sobrecarga cognitiva.

Por que isso importa

Manutenibilidade do código: Nomes de variáveis pouco claros atrasam a compreensão. Desenvolvedores gastam tempo descobrindo o que x, tmp ou val representam, em vez de focar na lógica real. Nomes ruins também tornam o código mais difícil de estender, pois não fica claro onde a nova lógica deve se encaixar ou como os valores existentes se relacionam. Além disso, nomes vagos tornam a base de código inpesquisável, já que a busca por tmp ou val não retorna resultados significativos. Isso se agrava ao retornar ao código meses depois ou quando novos membros da equipe se juntam.

Introdução de bug: Nomes ambíguos aumentam a chance de usar a variável errada. Quando múltiplas variáveis têm nomes crípticos semelhantes (d1, d2, d3), desenvolvedores podem usar o errado, introduzindo bugs sutis que passam pela revisão de código porque os nomes não fornecem pistas semânticas.

Exemplos de código

❌ Não-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;
}

Por que é impreciso: Nomes de variáveis como u, p, d, t, e 'a' não revelam nada sobre seu propósito. Os leitores devem rastrear a lógica de cálculo para entender que p é preço, d é o desconto, t é subtotal, e a é o valor antes dos impostos.

✅ Compatível:

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

Por que isso importa: Cada nome de variável descreve o que ela contém. amountAfterDiscount indica claramente o estado do cálculo, imposto é inequívoco, e produto e quantidade revelar as entradas da função sem a necessidade de ler o corpo.

Conclusão

Use nomes que revelem a intenção sem exigir contexto. Priorize a clareza em vez da brevidade. Os caracteres extras em preçoTotal versus tp não custam nada em execução, mas economizam um tempo significativo na compreensão.