Regla
Uso descriptivo nombres .
Muy cortos nombres de . hacen el código poco claro.

Idiomas compatibles: 45+

Introducción

Los nombres de variables de una sola letra o crípticos obligan a los lectores a deducir el significado del contexto en lugar de entender el código de un vistazo. Una variable llamada d podría representar fecha, duración, distancia o datos, requiriendo un esfuerzo mental para rastrear su propósito a lo largo de la función. Nombres descriptivos como userCreatedDate o duración de la solicitud haz que la intención sea inmediatamente clara sin sobrecarga cognitiva.

Por qué es importante

Mantenibilidad del código: Los nombres de variables poco claros ralentizan la comprensión. Los desarrolladores dedican tiempo a averiguar qué representan x, tmp o val en lugar de centrarse en la lógica real. Una mala nomenclatura también dificulta la extensión del código, ya que no está claro dónde debería encajar la nueva lógica o cómo se relacionan los valores existentes entre sí. Además, los nombres vagos hacen que la base de código sea inlocalizable, ya que buscar tmp o val no arroja resultados significativos. Esto se agrava al volver al código meses después o cuando se incorporan nuevos miembros al equipo.

Introducción de errores: Los nombres ambiguos aumentan la probabilidad de usar la variable incorrecta. Cuando múltiples variables tienen nombres crípticos similares (d1, d2, d3), los desarrolladores podrían usar el incorrecto, introduciendo errores sutiles que pasan la revisión de código porque los nombres no proporcionan pistas semánticas.

Ejemplos de código

❌ No 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 qué es inexacto: Nombres de variables como u, p, d, t, y 'a' no revelan nada sobre su propósito. Los lectores deben rastrear la lógica de cálculo para entender que p es precio, d es descuento, t es subtotal, y a es el importe antes de impuestos.

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

¿Por qué esto importa? Cada nombre de variable describe lo que contiene. importeTrasDescuento indica claramente el estado del cálculo, impuesto es inequívoco, y producto y cantidad revelar las entradas de la función sin necesidad de leer el cuerpo.

Conclusión

Utilice nombres que revelen la intención sin requerir contexto. Favorezca la claridad sobre la brevedad. Los caracteres adicionales en precioTotal versus tp no cuestan nada en ejecución, pero ahorran un tiempo considerable en la comprensión.