Cómo nombrar según el tipo de dato

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

Carina Payleman

student•

Arrays: Plural.
Booleanos: Con prefijos "is", "has" y "can". ("es verdadero", "tiene/contiene x", "puede hacer x").
Números: Con prefijos "min", "max" y "total".
Funciones: Verbo + sustantivo/s (ya que son acciones).
- ...de Acceso: get + sustantivo
- ...de Modificación: set + sustantivo;
- ....de Predicado: is + sustantivo;
Clases: Sustantivos (no genéricos).

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

//Booleanos:
const isValid = true;
const hasColor = true;
const canRead = false;

//Números:
const maxUsers = 50;
const minUsers = 10;
const totalUsers = 15;

//Funciones:
createUser();
updateUser();
sendEmail();
//Acceso:
getUser();
//Modificación:
setUser()
//Predicado:
isValidUser();

//Clases:
class User {}
class UserProfile {}
class Account {}

Billy Torres

student•

Excelentes notas, muchas gracias.

Elcira Ibarra

student•

Cómo nombrar variables, funciones y clases según su tipo de dato.

Recordemos que es importante, según las reglas de nomenclatura, no incluir información técnica dentro de los nombres, pero aún así, nuestro código debe ser autodescriptivo; por lo tanto, como buena práctica, desde el nombre, debemos denotar el tipo de dato.

// Arrays: lista de elementos, generalmento del mismo tipo.
// Se recomienda usar el nombre de la variable en plural.

// 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: solo tiene 2 valores, true o false.
// Se recomienda utilizar ciertos prefijos para identificar las variables: is(¿es?), has(¿tiene?), can(¿puede?).

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

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

// Numbers
// Se recomienda prefijos que hagan referencia a que la variable contiene números como: max, min y total; son autodescriptivas y también hablan de lo que hace el código.

// No recomendado
const users = 15;

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

// Funciones: representan una acción.
// Se recomienda que inicien con un verbo, seguido de un sustantivo, por ejemplo: get como verbo y name como sustantivo.
// Deben ser concisos y estar en camelCase.

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

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

// Funciones de acceso, modificación o predicado.
// Se recomienda añadir el prefijo de get, set o is.

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

// Clases
// Para nombrar clases se recomienda utilizar sustantivos, por ejemplo: user o userProfile, pero se debe evitar utilizar nombres genéricos como: data o manager, porque esto puede llevar a que estas clases tengan más de una sola responsabilidad.
// Según el principio de responsabilidad único tanto una clase como una función deben ser responsables de una sola acción.

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

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

Reinaldo Mendoza

student•

Buenos tips

Elcira Ibarra

student•

Éstas cosas uno las infiere en los cursos, pero está bueno aprender las reglas estandarizadas según el Clean Code para buenas prácticas.

Paulina Ignacio Sanvicente

student•

NOMENCLATURA SEGÚN TIPO DE DATO

ARRAYS: plural, ejemplo: const userNames = ["Ale", "Ana", "Aldo"] es decir, tipoPropiedad

BOOLEANOS: prefijos "is", "can", "has". ejemplo: const isValid = true; //es valido: si o no const canRead = false; //puede leerse: si o no const hasColor = false; //tiene color: si o no

NÚMEROS: prefijos "min", "max", "total" ejemplo: const maxUsers = 50;
const minUsers = 10;
const totalUsers = 100;

FUNCIONES: verbo+sustantico, acciones ejemplo: createUser(); updateUser(); sendEmail();

Otras tipos de funciones: …de Acceso: getUser(); …de Modificación: setUser(); …de Predicado: isValidUser();

CLASES: Sustantivos, no generales, dirigidos a fx ejemplo: User(); UserProfile(); Account();

Edgar A. Gonzalez Ambriz

student•

Maestra, olvidó la recomendación que dió en la clase antepasada que el nombre de las constantes debe ser en mayúscula. Esto me ha audado mucho

Axel Enrique Galeed Gutierrez

student•

Cómo nombrar según el tipo de dato

Arrays

Son una lista de elementos por lo general de un mismo tipo, se recomienda usar el nombre de la variable en plural.

// 😡 No recomendado 😡
const user = ['Galeed', 'Evelin', 'Aarón'];

// 😐 Regular 😐
const userList = ['Galeed', 'Evelin', 'Aarón'];

// 🙂 Bueno 🙂
const users = ['Galeed', 'Evelin', 'Aarón'];

// 😊 Recomendado 😊
const userNames = ['Galeed', 'Evelin', 'Aarón'];

Booleanos

Estos solo pueden tener dos estados o dos valores, true o false.

Es recomendable usar ciertos prefijos para identificar a las variables como is, has, can.

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

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

Números

Contiene números de cualquier tipo, es comendable agregarlo un prefijo como min, max, total.

// 😡 No recomendado 😡
const users = 15;

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

Funciones

Por la naturaleza de estas representan una acción y al representar una acción es por eso que se recomienda que su nombre empiece por un verbo y continúe con un sustantivo. El nombre tiene que ser conciso, es decir, que se espera (en pocas palabras) que haga esa función.

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

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

Funciones de acceso

Recomendable utilizar el prefijo get.

Funciones de modificación

Recomendable emplear el prefijo set.

Funciones de predicado

Recomendable utilizar el prefijo is.

// 😊 Recomendado 😊
getUser();
setUser();
isValidUser();

Clases

Para estos es recomendable usar sustantivos. No utilizar nombres genéricos, esto puede llevar a que la clase tenga más de una responsabilidad.

// 😡 No recomendado 😡
class Data {};
class Manager {};
class Infor {};

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

Andres Gallego

student•

No termino de entender del todo que tiene de malo, por ejemplo createUserIfNotExist() dice que se brinda mucha información, pero qué complicaciones tendria eso a futuro?

Carlos Javier Majerhua Nuñez

student•

Tienes razón!

Julio Cardenas

student•

Yo pienso que la funcion es createUser().

Si el usuario existe o no existe es una condicion que se debe manejar adentro de la funcion.

Leonardo Holguin Arias

student•

Lo más difícil para mí es nombrar las variables dentro de un ciclo, por ejemplo, si quiero recorrer una lista de users, ¿la variable dentro del ciclo debe llamarse user? ¿Y que pasa si ya tengo una variable user previamente hecha?

Leiber Bertel

student•

Hola, si ya tienes una variable user, usa nombres como currentUser o userItem en el ciclo para evitar conflictos y mantener claridad en el código.

Marlen Jara Cruz

student•

Ay por Dioooos, está clase me encanto !! Me volo la cabeza Libere endorfinaaaas !!! xD la ame. siento que evoluciono jaja

Kengya Moncada

student•

WOW sufrìa como nombrar mis variables, ahora lo sé. 😄

Maria Alejandra Luna Tito

student•

me gusta mucho este curso hay buena informacion, alguien sabe si este curso se basa en algun libro? o que libro recomiendan?

Kyb3r Cipher

student•

Me esta encantado este curso

Ana Rotela Cabrera

student•

Apuntes de la clase

Luis Eduardo Payano Villar

student•

//arrays is a collection of data structures

//Don't use

const user = ["Juan", "John", "Peter"];

// Regular

const userlist = ["Kevin","Paul","John"];

// Aceptable

const users = ["Kevin","Paul","John"];

// Excelente

const usersNames = ["Kevin","Paul","John"];

//Boolean keys 

// dont use

const valid = true;
const read = false;
const color = true


// use this

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

////////////////////////////////
//Number

//dont use

const users = 150;

// use this
const maxUsers = 150;
const minUsers = 20;
const totalUsers = 200;


///////////////////////////////
//functions

//dont use
createUserIfNotExist();
updateUseIfNotEmpty();
sendEmailIfIsValid();

//Use This

createUser();
updateUser();
sendEmail();

//Accions functions

getUsers(); //Accessibility functions
setUsers(users); //Modification functions
isValidUsers(); //Permissions functions

//////////////////////////////////
//class recommendation

//dont use
class Data{};
class Manager{};
class Info{};

//use this
class User{};
class UserManager{};
class UserProfile{};
class AccountUser{};

Stephania Millán

student•

Arreglos

//No Recomendado const x = [1, 2, 3, 4, 5] const name = ['Cande', 'Alex', 'Mariana'] const colors = ['red', 'green', 'blue']

//Recomendado const integers = [1, 2, 3, 4, 5] const userNames = ['Cande', 'Alex', 'Mariana'] const profileColors = ['red', 'green', 'blue']

Booleanos

//No Recomendado const active = true const correct = false const write = true const user = false

//Recomendado const isActive = true const isCorrect = false const canWrite = true const isUser = false

Números

//No Recomendado let result = 3543 const y = 20 const PI = 3.14159

//Recomendado let totalResult = 3543 const circleRadio = 20 const piNumber = 3.14159

Funciones

//No Recomendado sendAlertIfIsEmpty() ifNotExistCreateNewObject() password() results()

//Recomendado sendAlert() createNewObject() setpassword() getResults()

Clases

//No Recomendado class School {} class NewService {} class ImplementNewAccount {}

//Recomendado class Students {} class Services {} class Account {}

Eugenio Condori

student•

/*****ARRAYS*****/
//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"];

/*****BOOLEANOS*****/
//No recomendado
const valid = true;
const read = false;
const color = true;
//Recomendado
const isValid = true;
const canRead = false;
const hasColor = true;

/*****NÚMEROS*****/
//No recomendado
const users = 15;
//Recomendado
const maxUsers = 50;
const minUsers = 10;
const totalUsers = 15;

/*****FUNCIONES*****/
//No recomendado
createUserIfNotExists();
updateUserIfNotEmpty();
sendEmailIfIsValid();
//Recomendado
createUser();
updateUser();
sendEmail();

getUser(); //acceso
setUser(); //modificación
isValidUser(); //predicado

/*****CLASES*****/
class User {}
class UserProfile {}
class Account {}

Axel Enrique Galeed Gutierrez

student•

Les comparto mis apuntes. 😁

Arrays

Son una lista de elementos por lo general de un mismo tipo, se recomienda usar el nombre de la variable en plural.

// 😡 No recomendado 😡
const user = ['José', 'Maria', 'Elena'];

// 😐 Regular 😐
const userList = ['José', 'Maria', 'Elena'];

// 🙂 Bueno 🙂
const users = ['José', 'Maria', 'Elena'];

// 😊 Recomendado 😊
const userNames = ['José', 'Maria', 'Elena'];

Booleanos

Estos solo pueden tener dos estados o dos valores, true o false.

Es recomendable usar ciertos prefijos para identificar a las variables como is, has, can.

// 😡 No recomendado 😡
const user = ['Galeed', 'Evelin', 'Aarón'];

// 😐 Regular 😐
const userList = ['Galeed', 'Evelin', 'Aarón'];

// 🙂 Bueno 🙂
const users = ['Galeed', 'Evelin', 'Aarón'];

// 😊 Recomendado 😊
const userNames = ['Galeed', 'Evelin', 'Aarón'];

Números Contiene números de cualquier tipo, es comendable agregarlo un prefijo como min, max, total.

// 😡 No recomendado 😡
const users = 15;

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

===

Funciones

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

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

Funciones de acceso

Recomendable utilizar el prefijo get.

Funciones de modificación

Recomendable emplear el prefijo set.

Funciones de predicado

Recomendable utilizar el prefijo is.

// 😊 Recomendado 😊
getUser();
setUser();
isValidUser();

Clases

Para estos es recomendable usar sustantivos. No utilizar nombres genéricos, esto puede llevar a que la clase tenga más de una responsabilidad.

// 😡 No recomendado 😡
class Data {};
class Manager {};
class Infor {};

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

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

//Booleanos:
const isValid = true;
const hasColor = true;
const canRead = false;

//Números:
const maxUsers = 50;
const minUsers = 10;
const totalUsers = 15;

//Funciones:
createUser();
updateUser();
sendEmail();
//Acceso:
getUser();
//Modificación:
setUser()
//Predicado:
isValidUser();

//Clases:
class User {}
class UserProfile {}
class Account {}

// Arrays: lista de elementos, generalmento del mismo tipo.
// Se recomienda usar el nombre de la variable en plural.

// 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: solo tiene 2 valores, true o false.
// Se recomienda utilizar ciertos prefijos para identificar las variables: is(¿es?), has(¿tiene?), can(¿puede?).

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

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

// Numbers
// Se recomienda prefijos que hagan referencia a que la variable contiene números como: max, min y total; son autodescriptivas y también hablan de lo que hace el código.

// No recomendado
const users = 15;

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

// Funciones: representan una acción.
// Se recomienda que inicien con un verbo, seguido de un sustantivo, por ejemplo: get como verbo y name como sustantivo.
// Deben ser concisos y estar en camelCase.

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

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

// Funciones de acceso, modificación o predicado.
// Se recomienda añadir el prefijo de get, set o is.

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

// Clases
// Para nombrar clases se recomienda utilizar sustantivos, por ejemplo: user o userProfile, pero se debe evitar utilizar nombres genéricos como: data o manager, porque esto puede llevar a que estas clases tengan más de una sola responsabilidad.
// Según el principio de responsabilidad único tanto una clase como una función deben ser responsables de una sola acción.

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

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

// 😡 No recomendado 😡
const user = ['Galeed', 'Evelin', 'Aarón'];

// 😐 Regular 😐
const userList = ['Galeed', 'Evelin', 'Aarón'];

// 🙂 Bueno 🙂
const users = ['Galeed', 'Evelin', 'Aarón'];

// 😊 Recomendado 😊
const userNames = ['Galeed', 'Evelin', 'Aarón'];

//arrays is a collection of data structures

//Don't use

const user = ["Juan", "John", "Peter"];

// Regular

const userlist = ["Kevin","Paul","John"];

// Aceptable

const users = ["Kevin","Paul","John"];

// Excelente

const usersNames = ["Kevin","Paul","John"];

//Boolean keys 

// dont use

const valid = true;
const read = false;
const color = true


// use this

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

////////////////////////////////
//Number

//dont use

const users = 150;

// use this
const maxUsers = 150;
const minUsers = 20;
const totalUsers = 200;


///////////////////////////////
//functions

//dont use
createUserIfNotExist();
updateUseIfNotEmpty();
sendEmailIfIsValid();

//Use This

createUser();
updateUser();
sendEmail();

//Accions functions

getUsers(); //Accessibility functions
setUsers(users); //Modification functions
isValidUsers(); //Permissions functions

//////////////////////////////////
//class recommendation

//dont use
class Data{};
class Manager{};
class Info{};

//use this
class User{};
class UserManager{};
class UserProfile{};
class AccountUser{};

/*****ARRAYS*****/
//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"];

/*****BOOLEANOS*****/
//No recomendado
const valid = true;
const read = false;
const color = true;
//Recomendado
const isValid = true;
const canRead = false;
const hasColor = true;

/*****NÚMEROS*****/
//No recomendado
const users = 15;
//Recomendado
const maxUsers = 50;
const minUsers = 10;
const totalUsers = 15;

/*****FUNCIONES*****/
//No recomendado
createUserIfNotExists();
updateUserIfNotEmpty();
sendEmailIfIsValid();
//Recomendado
createUser();
updateUser();
sendEmail();

getUser(); //acceso
setUser(); //modificación
isValidUser(); //predicado

/*****CLASES*****/
class User {}
class UserProfile {}
class Account {}

// 😡 No recomendado 😡
const user = ['José', 'Maria', 'Elena'];

// 😐 Regular 😐
const userList = ['José', 'Maria', 'Elena'];

// 🙂 Bueno 🙂
const users = ['José', 'Maria', 'Elena'];

// 😊 Recomendado 😊
const userNames = ['José', 'Maria', 'Elena'];

// 😡 No recomendado 😡
const user = ['Galeed', 'Evelin', 'Aarón'];

// 😐 Regular 😐
const userList = ['Galeed', 'Evelin', 'Aarón'];

// 🙂 Bueno 🙂
const users = ['Galeed', 'Evelin', 'Aarón'];

// 😊 Recomendado 😊
const userNames = ['Galeed', 'Evelin', 'Aarón'];

Cómo nombrar según el tipo de dato

Introducción al Clean Code

Deuda técnica y refactorización de código

Reglas del diseño simple

Qué es Clean Code

Nombre y uso de las variables

Uso correcto de var, let y const

Reglas para la nomenclatura