Reglas para la nomenclatura

Reglas de nomenclatura.

¿Cómo nombro correctamente mis variables, funciones, etc…?

1. Nombres pronunciables y expresivos. Preferentemente en inglés usando camelCase🐫, evitando guiones - o _ y abreviaturas.
2. Nombres sin información técnica. Evitar nombres con relación a la tecnología (tipo de datos, clases, etc). Ej. “arrayNames” --> “namesList”
3. Usar lenguaje ubicuo (ubiqueé???): aquel que se construye a partir del lenguaje que usan los expertos, es decir: crear un lenguaje en común para desarrolladores e interesados, determinando palabras de uso común.

El lenguaje ubicuo, también conocido como lenguaje universal, es un concepto desarrollado por el experto en tecnología de la información y autor Martin Fowler, que se refiere a un lenguaje común y compartido entre todos los miembros de un equipo o empresa, independientemente de sus antecedentes, roles o áreas de experiencia.

El objetivo del lenguaje ubicuo es mejorar la comunicación y la colaboración en un equipo, especialmente en proyectos complejos en los que participan varias partes interesadas. Al establecer un conjunto común de términos y definiciones, se pueden evitar malentendidos, errores y retrasos, lo que puede mejorar la eficiencia y la calidad del trabajo.

El lenguaje ubicuo se basa en la idea de que las personas utilizan el lenguaje para modelar su comprensión de un dominio. Al establecer un lenguaje compartido, se puede mejorar la comprensión de un proyecto o sistema, lo que puede conducir a una mejor toma de decisiones y mejores resultados.

Recuerden siempre utilizar PascalCase para nombrar clases. Esto también aplica para nombrar alias types e interfaces en TypeScript

Reglas para la nomenclatura

➯ Para contribuir a que nuestro código sea limpio hay que nombrar correctamente a nuestras variables funciones y clases, las variables funciones, etc deben ser expresivas, es decir en ingles y camel case, evitar el uso de guiones, guiones bajos y abreviaturas.

// no recomendado
const yyyymmdstr = moment().format("YYYY/MM/DD");

// no recomendado
const currentDate = moment().format("YYYY/MM/DD");

➯ Nombres sin información técnica , evitar usar nombre relacionados a la tecnología, tipo de dato o clase.

// No recomendado
let arrayNames = ["Alex", " Mariana", "Cande"];
//recomendado
let namesList = ["Alex", " Mariana", "Cande"];

➯ Usar lenguaje ubicuo, ques es? aquel que se construye a partir del lenguaje que usan los expertos en el dominio, un lenguaje en común entre los devs y los interesados

// no recomendado
getUserInfo();
getClientData();
getCustomerRecord();

// recomendado
getUser();

tanto user, client and customer se pueden agrupar en user, si representan el mismo concepto. (representar a un usuario)

Lenguaje ubicuo, es un término usado en el desarrollo, para entenderlo más fácil, imagina que es la jerga que tienes en tu grupo de amigos cuándo es un proyecto en un equipo. Ejemplo: Decir ‘Se está ofreciendo’ y que todos entiendan que ‘Estaría bien hacer esto’.

Y es como la jerga de una región cuándo es de un lenguaje, como en este caso (Javascript).
Ejemplo:
En España dices 'Lo está petando’
En México dices ‘La está rompiendo’

En ambos casos te podrán entender que ‘Le está yendo muy bien’, pero para evitar confusión y sonar raro, a dónde vas, haces lo que ves.
Como en Javascript dices getUser() y en Python dices get_user()

NOMENCLATURA

Nombres pronunciables y expresivos: en inglés, usando camelCase, evitando guiones “-”, “_” y abreviaturas.

Nombres sin info técnica: tipo de datos, clases,etc.

Usar lenguaje ubicuo: lenguaje en común entre devs y stakeholders.

Nombres descriptivos de lo que hace/usa la variable/funcion