🚀Clean Code y buenas prácticas con JavaScript - Cómo nombrar variables, funciones y clases de forma autodescriptiva

Nombrar correctamente nuestras variables, funciones y clases es esencial para escribir un código limpio y comprensible. Aunque las reglas de nomenclatura nos dicen que evitemos detalles técnicos, es crucial que nuestros nombres reflejen la naturaleza y el propósito de cada elemento. Aquí hay algunas pautas para nombrar según el tipo de dato:

Arrays: Lista de Elementos

Cuando trabajamos con arrays, es fundamental usar nombres de variables en plural para denotar su naturaleza de colección. Veamos la evolución de un nombre:

// No recomendado
const user = ["Alex", "Mariana", "Jessica"];

// Regular
const userList = ["Alex", "Mariana", "Jessica"];

// Bueno
const users = ["Alex", "Mariana", "Jessica"];

// Excelente
const userNames = ["Alex", "Mariana", "Jessica"];

Booleans: Valores True o False

Para variables booleanas, es útil agregar prefijos que indiquen su naturaleza. Utilizamos "is," "has," o "can" para hacer que el nombre sea más descriptivo:

// No recomendado
const valid = true;
const read = false;
const color = true;

// Recomendado
const isValid = true;
const canRead = false;
const hasColor = true;

Números: Variables que Contienen Valores Numéricos

Cuando trabajamos con números, prefijos como "max," "min," y "total" ayudan a entender el propósito de la variable:

// No recomendado
const users = 15;

// Recomendado
const maxUsers = 50;
const minUsers = 10;
const totalUsers = 15;

Funciones: Acciones en el Código

Las funciones representan acciones y deben ser concisas y descriptivas. Se sugiere que inicien con un verbo seguido de un sustantivo:

// No recomendado
createUserIfNotExist();
updateUserIfNotEmpty();
sendEmailIfIsValid();

// Recomendado
createUser();
updateUser();
sendEmail();

Funciones de Acceso, Modificación o Predicado

Cuando se trata de funciones de acceso, modificación o predicado, añadir prefijos como "get," "set," o "is" mejora la legibilidad:

// Ejemplo
getUser();
setUser();
isValidUser();

Clases: Responsabilidad Única y Sustantivos Descriptivos

En el caso de clases, es crucial seguir el principio de responsabilidad única y utilizar sustantivos descriptivos en lugar de nombres genéricos:

// No recomendado
class Data {}
class Manager {}
class Info {}

// Recomendado
class User {}
class UserProfile {}
class Account {}

Siguiendo estas prácticas de nomenclatura, tu código se volverá más autodescriptivo, facilitando su mantenimiento y comprensión tanto para ti como para otros desarrolladores que puedan trabajar con él.