54

Una buena práctica para escribir código: nombrar elementos

14871Puntos

hace 2 años

¿Les ha pasado que están súper inspirados escribiendo código pero repentinamente necesitan una luz divina que les diga qué nombre ponerle a la variable que están a punto de escribir?

Como Frontend, hay tantas cosas que debo nombrar en mi día a día: clases para cada elemento HTML, variables en Stylus que puedan ser reutilizables, componentes, archivos, funciones… Tengo que poner a volar mi imaginación para poder lograrlo.

A pesar de que es algo que depende totalmente de nosotros y no hay una forma estrictamente correcta o incorrecta de hacerlo, nombrar cada elemento es un trabajo en el que debemos poner empeño, pues se verá impactado en la organización y mantenibilidad de nuestro código.

Fanny es parte del Team Platzi. Si quieres una carrera en Frontend, empieza por el Curso de Desarrollo Web y luego el Curso de Responsive Design.

Lo más importante es que el nombre que le asignes siempre refleje el trabajo que está haciendo, de esta forma podemos incluso reducir la necesidad de comentar cada línea de código con su funcionamiento.

A continuación algunos consejos que hay que seguir para evitar algún desastre a la hora de nombrar un elemento en tu código.

Nombres descriptivos

Abreviar nombres puede que en algunos casos no sea tan buena idea. Seguramente con el paso del tiempo o cuando un nuevo desarrollador tenga que darle mantenimiento a tu código habrá quedado en el olvido lo que esa variable representa. Lo ideal es utilizar nombres que describan la funcionalidad de nuestro código.

Por ejemplo, es mucho más descriptivo escribir:

functionreceipt(){
....
return ingredient;
}

que:

functiona(){
....
return b;
}

Nombres conformados por un conjunto de palabras

Generalmente los lenguajes de programación no permiten espacios en las variables. Sin embargo hay distintos métodos para separar el conjunto de palabras que conforman una variable y que de esta manera logren ser más legibles. Esto se puede hacer capitalizando cada palabra agrupada (camelCase) o separando cada palabra con underscore
(snake_case).

Por ejemplo:

var post_likes = 4;

o

var postWords = 320;

La longitud de el nombre asignado

A pesar de que los nombres de variables cortos deben ser sustituidos por nombres de variables más largos y descriptivos, no quiere decir que tenemos que usar frases completas. Es importante que el nombre describa qué es lo que el código asignado hace y no cómo lo hace. Utilizar un nombre largo puede incluso ser más susceptible a errores tipográficos a la hora de escribirlo. Se dice que la longitud recomendable es de 2 a 4 palabras o entre 8 y 20 caracteres.

En conclusión nombrar elementos no es difícil, más bien es un súper poder o habilidad que va mejorando con la práctica. Nosotros como desarrolladores tenemos la responsabilidad de hacerlo lo mejor posible.

Si recién comienzas a programar, te invito al Curso de programación básica para empezar a implementar estos consejos en tus proyectos. Y si llevas ya tiempo programando sin hacer uso de ellos, compártenos cómo te va siguiendo estas recomendaciones. Estoy segura que los desarrolladores que se topen con tu código en el futuro te lo agradecerán.

Fannytaviles
Fannytaviles
@fannytaviles

14871Puntos

hace 2 años

Todas sus entradas
Escribe tu comentario
+ 2
Ordenar por:
8
1814Puntos

En nuestra empresa, tenemos como “estándar” interno, los métodos ya sean de Javascript o bien propios del lenguaje de backend, poner el nombre que describa exactamente lo que hace, por ejemplo

defverificar_si_no_existe_despues_de(variable)
	...
end

Por más que sea largo, de esta forma ya todo el equipo sabe que hace y nos ahorramos estar averiguando que responsabilidad o que acción tiene ese método.

En el caso de las variables, tratamos siempre también que sean lo más descriptivas posibles pero acotar la cantidad de letras, por ejemplo:

let numDni
0
14871Puntos
2 años

Super! Y muy cierto, la longitud no importa, lo importante es que sea descriptivo 😃

4
46Puntos

Muchas_gracias. ExcelenteConsejo

1
7079Puntos

Esto es lo que me enseñaron en la universidad

Por norma estricta
1.- Variables si son compuestas se separan por underline “_”:
No se usa el guión medio para que no se confunda con una operación matemática.

2.- Funciones usan CamelCase, para distinguirlas de las variables y sólo si se requiere para separar relacionalmente una funcion dentro de una familia se usa uderline “_”

Ej:

hola_esto_es_una_variable = 1;
y
holaYoSoyUnaFuncion(“holi”);
fix_soyUnaFuncionExterna(“chao”);

Las variables actualmente tienen que ser descriptivas, antiiiiiguamente sólo teníamos 8 caracteres o bits y teníamos que usar variables muy cortas, actualmente son 255 caracteres, así que te puedes expresar libremente.

EJ ( 251 Chars ):
hola_yo_soy_una_variable_de_muchos_caracteres_aqui_puedo_poner_una_cosa_muy_larga_bueno_se_entiende_la_idea_esta_variable_es_muy_larga_y_descriptiva_por_lo_que__necesario_que_te_limites_con_los_nombres_de_las_variables_a_no_ser_que_te_preocupe_el_peso

1
3Puntos

Leyendo el post puede parecer evidente que hay que poner nombres que definan inequívocamente qué hacen, pero aún así nos hartamos de ver código con variables indescifrables.

Tomo nota del post y lo comparto con algunos…xD

1

Gracias,
creo que ahora puedo entender un poco mas como nombrar las variables
PD:Soy aprendis

1
145Puntos

excelente muchas gracias por el articulo

1
50Puntos

Excelente artículo!

1
2427Puntos

Me gusta eso del super poder, programar te da muchos 😆

1
11Puntos

Ese es un primer paso importante. Luego está agrupar la declaración de variables, y colocarles para qué serán utilizadas

0
14871Puntos
2 años

Lo ideal es que el nombre sea tan descriptivo que no haya necesidad de colocar para qué será utilizada 😃

1
15850Puntos

yo antes hacia el error de abreviar nombres

0
14871Puntos
2 años

Cuando recién comenzaba, me llegó a pasar también. Tenía la sensación de que un nombre largo estaba mal 😦

1
6117Puntos

Conclusión: Nombra tus variables de una forma descriptiva pero no te pases.

0
14871Puntos
2 años

Descriptiva es lo importante 😃

1
1272Puntos

Gracias por los consejos, son sencillos pero muy útiles.

1

Hay un dicho de hace ya glum tiempo: “solo hay dos cosas muy difíciles en la programación: nombrar cosas e invalidar cache”

Estos tips para nombrar variables son claves y ayudan a que poco a poco deje de ser tan difícil 😁

0
14871Puntos
2 años

Parece simple pero es difícil 😦

1
695Puntos

Muy buenos concejos, me ha tocado darle mantenimiento a programas realizados por programadores que ya no están en la empresa donde trabajo, y me he topado con variables que dificultan mucho en entender su función.

0
14871Puntos
2 años

Me ha pasado, dan ganas de hacerle algo a la persona 🌚

0
11Puntos

A la grande le puse cuca