Reglas para la nomenclatura

Clase 5 de 24 • Curso de Clean Code y Buenas Prácticas con JavaScript

Clase anteriorSiguiente clase

Carina Payleman

student•

Reglas de nomenclatura.

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

Nombres pronunciables y expresivos. Preferentemente en inglés usando camelCase🐫, evitando guiones - o _ y abreviaturas.
Nombres sin información técnica. Evitar nombres con relación a la tecnología (tipo de datos, clases, etc). Ej. "arrayNames" --> "namesList"
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.

Sharon Gizela Arana Mendoza

student•

jajajaja el 'ubiqueee??' me hizo el día! <3

Santiago Andres Alvarez Cuadros

student•

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

Arturo Malgor

student•

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.

Sergio Brandon De Lucio Chavero

student•

El ejemplo sobre el lenguaje ubicuo tiene bastante que ver con el desarrollo de software debido a que cuando creamos una base de datos tenemos que definir las entidades y esas entidades pueden ser el ejemplo de clientes usuarios etc. todo lo podemos juntar en usuarios y después partir en dimensiones de direcciones, ubicaciones, billeteras, contacto, etc. entonces esto no solamente afecta la legibilidad del código también afecta la estructura de la base de datos la mantenibilidad de la misma y además de que respeta el principio DRY debido a que el código que tendríamos que escribir para llamar la Data de los diferentes nombres que se le da al usuario es básicamente el mismo y se repite tres veces.

Jose Gabriel Argüello

student•

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)

Juan Antonio Delgadillo Carrillo

student•

yo solo tengo una duda y no es escusa para no aprender ingles, pero por que simpre en ingles si LATAM somos demasiados que hablamos español .. y por que USA es quien saca solo la tecnologia ami me gustaria globalizar mas el idioma español

const diaActual 
const  sumarNumeros
const busqeuda
const verificarResolucion

ami me gusta mas asi cuando aprend y cree proyectos los are de esta forma pero claro que si entrare ala escuela de academy inglis

Sandra Rosa Arroyo Paredes

student•

Razones del uso del inglés:

Historia: Muchos lenguajes de programación y tecnologías se originaron en países de habla inglesa.
Estandarización: El inglés se ha convertido en una lingua franca en tecnología, facilitando la colaboración global.
Bibliotecas y documentación: La mayoría están en inglés inicialmente.
Mercado laboral: Muchas empresas internacionales requieren inglés.

Sin embargo, tienes razón en señalar la importancia del español:

Comunidad hispanohablante: Es enorme y creciente en el mundo tech.
Localización: Hay un aumento en la traducción de recursos y documentación al español.
Iniciativas regionales: Crecen los proyectos y startups tecnológicas en países hispanohablantes.
Inclusividad: El uso del español puede hacer la tecnología más accesible en regiones hispanohablantes.

Consideraciones prácticas:

Código base: Si trabajas en un proyecto existente, es mejor mantener la consistencia lingüística.
Equipo de trabajo: Considera el idioma principal de tu equipo.
Proyectos open source: El inglés puede atraer más colaboradores globales.
Proyectos locales/regionales: El español puede ser más apropiado.

Jonathan Meixueiro

student•

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()

Oscar Agustin Flores Arana

student•

El siguiente código no contempla estrictamente palabras en ingles. Sin embargo funcionan sin problemas. ¿donde quedaría si no la posibilidad de inventiva? si se tiene que someter la programación como si fuera una biblia donde se repite sin saber que se repite function crearGato(nombre, edad) { var perro = { nombre: nombre, edad: edad, meow: function() { return "Meow!"; } }; return perro; }

Francisco Ponce

student•

La cuestión es que no hacemos el código para nosotros, sino para todo un equipo de trabajo o para futuras personas que lleguen a darle mantenimiento. Es lo que pasa en la vida laboral, y sí, el código funciona, pero si esta porción de código llega a ser turnada con un equipo global, estoy seguro de que no será legible, y el equipo tendrá que desperdiciar tiempo de desarrollo (que es muy caro) para poder descifrar cosas como: por qué retornar un objeto perro si estamos creando un gato, por qué utilizar var y no const al crear una variable.

Toca facilitar la legibilidad del código para que pueda ser leído por otras personas que tengan conocimiento en el lenguaje de programación, y no tanto de nuestro idioma.

Podríamos cambiar el código a esto para hacerlo más legible.

function createCat(name, age) {
    const cat = {
        name,
        age,
        growl: function() {
            return "Meow!";
        }
    };
    return cat
}

E incluso refactorizarlo hasta tener una sintaxis más parecida a ES6 (también hay que saber cuando factorizar, si es necesario y si en realidad mejora su legibilidad)

const createCat = (name, age) => ({
    name,
    age,
    growl: () => "Meow"
})

xi Rg

student•

Hola, alguien ha visto alguna clase sobre EMMET en Platzi? He buscado en todo el catálogo Aún no encuentro

José Fernando Fuentes Roa

student•

Hola Avv, realmente no es necesario crear una sola clase para EMMET, con que leas la documentación en una hora aprendes lo básico para crear los bloques HTML de manera rápida. Mira, acá está la documentación oficial.

Daniel Ochoa

student•

Cuando la aplicación es muy grande hay procesos muy especificos, entonces me queda la duda de esa última regla que tan estricta debe ser, ya que hay cosas puntuales como conseguir el telefono de un usuario, los datos del creador de un post, cosas así.

Como debería nombrarse en estos casos?

Lincol Luis Gorpa Cruzado

student•

¿Por qué para arrayNames lo correcto es namesList? ->

Según esa lógica existiría (namesSet, namesDict, namesTupa...) ?
Un array no es lo mismo que un List array es con cantidad definido y List es expandible.
O porque no listNames?

¿Lo correcto no seria name si tuviera un valor y para muchos valores seria names?.

Respuestas por favor. Gracias.

Sandra Rosa Arroyo Paredes

student•

por que no listNames? Pues por la gramatica en ingles primero es el adjetivo y luego el sustantivo. name list, asi que lo correcto segun gpt es nameList.

Axel Enrique Galeed Gutierrez

student•

Consulta.

En la clase anterior la profesora dijo que recomienda declarar las contantes con mayúsculas, pero ahora nos dice que usemos camelCase ¿Cuál deberíamos usar?

Tengo entendido que por practicidad y mejor lectura del código tendríamos que utilizar mayúsculas para las contantes. Gracias. :D

Joan Manuel Theran Burgos

student•

y como serai el nombre de esas variables que solo usamos una vez y ya, por ejemplo para parsear, eliminar esapcios de un texto, etc?

Ariel Ezequiel Biazzo Genua

student•

Bueno, al ser una funcion podrias poner por ej:

removeSpaces()

Fijate que remove es una accion pero no le agregue ningun tecnisismo como FN de function.

Si tienes ganas, puedes usar bard o gpt para explorar mas ideas!

Maria Alejandra Luna Tito

student•

a mi me cuesta mucho nombrar mis variables y funciones, y mas porq esto se debe hacer en ingles

Ana Rotela Cabrera

student•

Resumen de la clase

David Galvan

student•

Utiliza nombres descriptivos: Elige nombres que sean claros y expresivos, de manera que otros desarrolladores puedan entender fácilmente el propósito y la función de una variable, función o clase.
Evita nombres genéricos: Evita utilizar nombres como "data", "temp", "x", etc. que no aportan información sobre su contenido o propósito. Opta por nombres más descriptivos y significativos.
Utiliza camelCase: En JavaScript, es común utilizar el estilo camelCase para nombrar variables y funciones. Esto significa que la primera letra de la primera palabra es minúscula, y la primera letra de las palabras siguientes es mayúscula. Por ejemplo: miVariable, miFuncion.
Evita el uso de abreviaciones confusas: Aunque las abreviaciones pueden ahorrar tiempo al escribir código, pueden dificultar la comprensión del mismo. Utiliza nombres completos y significativos en lugar de abreviaciones confusas.
Sigue las convenciones de estilo: Es importante seguir las convenciones de estilo establecidas por la comunidad de JavaScript. Por ejemplo, utiliza const para variables que no cambian, let para variables que sí cambian, y function o arrow functions para definir funciones.
Organiza tu código: Mantén tu código limpio y bien estructurado. Utiliza indentación adecuada, espacios en blanco y comentarios para facilitar la lectura y comprensión del código.

Axel Enrique Galeed Gutierrez

student•

Consulta. En la clase anterior la profesora dijo que recomienda declarar las contantes con mayúsculas, pero ahora nos dice que usemos camelCase ¿Cuál deberíamos usar? Tengo entendido que por practicidad y mejor lectura del código tendríamos que utilizar mayúsculas para las contantes. Gracias. :D

Sandra Rosa Arroyo Paredes

student•

las const si deben ser con mayusculas los let con camelcase Ejemplo: - EMPTY_TEXT = '' - nameList = [...]

Axel Enrique Galeed Gutierrez

student•

@Sandra, muchas gracias. 😁

Emerson Cedeño

student•

Sobre el naming convention en variables algunas recomendaciones que me han sido de gran utilidad (extrapolable a otros lengs. de programación*), sumado a lo dictado en este bloque de clases sobre "Nombre y uso de las variables":

usar camelCase para variables y funciones / métodos. Ejemplos: userNames, isActive, totalUsers, getUser()
... para variables y funciones privadas usar _camelCase (sí notaron el underscore como prefijo?). Ejemplo: _userAge, _dogBreed
usar PascalCase para clases y componentes. Ejemplos: UserProfile
usar UPPER_SNAKE_CASE u UPPERFLATCASE para constantes. Ejemplo: DB_NAME, DBHOST
usar kebab-case para el nombre de archivos Ejemplo: dog-cartoon.js

Alguna otra recomendación? 🤓

Eugenio Condori

student•

//REGLA 1 => Nombres pronunciables y expresivos usando camelCase
//No recomendado
const yyyymmdstr = moment.format("YYYY/MM/DD");
//Recomendado
const currentDate = moment.format("YYYY/MM/DD");

//REGLA 2 => Nombres sin información tecnica (tipo de dato, tipo de clases, etc)
//No recomendado
let arrayNames = ["Juan", "Pedro", "Maria"];
//Recomendad
let namesList = ["Juan", "Pedro", "Maria"];

//REGLA 3 => Usar lenguaje ubicuo,crear un lenguaje en común para desarrolladores e 
//interesados, determinando palabras de uso común.
//No recomendado
getUserId();
getClientData();
getCustomerRecord();
//Recomendado
getUser();
```*//REGLA 1 => Nombres pronunciables y expresivos usando camelCase//No recomendado*const yyyymmdstr = moment.format("YYYY/MM/DD");*//Recomendado*const currentDate = moment.format("YYYY/MM/DD");
*//REGLA 2 => Nombres sin información tecnica (tipo de dato, tipo de clases, etc)//No recomendado*let arrayNames = \["Juan", "Pedro", "Maria"];*//Recomendad*let namesList = \["Juan", "Pedro", "Maria"];
*//REGLA 3 => Usar lenguaje ubicuo,crear un lenguaje en común para desarrolladores e //interesados, determinando palabras de uso común.//No recomendado*getUserId();getClientData();getCustomerRecord();*//Recomendado*getUser();

Paulina Ignacio Sanvicente

student•

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.