DEV Community

Vanessa
Vanessa

Posted on

1

🚀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"];
Enter fullscreen mode Exit fullscreen mode

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;
Enter fullscreen mode Exit fullscreen mode

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;
Enter fullscreen mode Exit fullscreen mode

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();
Enter fullscreen mode Exit fullscreen mode

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();
Enter fullscreen mode Exit fullscreen mode

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 {}
Enter fullscreen mode Exit fullscreen mode

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.

Postmark Image

Speedy emails, satisfied customers

Are delayed transactional emails costing you user satisfaction? Postmark delivers your emails almost instantly, keeping your customers happy and connected.

Sign up

Top comments (1)

Collapse
 
juanfrank77 profile image
Juan F Gonzalez

👏👏

A Workflow Copilot. Tailored to You.

Pieces.app image

Our desktop app, with its intelligent copilot, streamlines coding by generating snippets, extracting code from screenshots, and accelerating problem-solving.

Read the docs

👋 Kindness is contagious

Please leave a ❤️ or a friendly comment on this post if you found it helpful!

Okay