Buenas prácticas nombrando y utilizando variables
Es común que después de algunos años desconozcas uno o más aspectos de los que voy a tratar a continuación. Nombrar y utilizar variables suele ser mucho más sencillo en la teoría que en la práctica. Sin embargo, recuerda que el mundo del desarrollo avanza demasiado rápido y lo que puede parecer la última palabra hoy, puede que mañana no lo sea. Veamos pues algunas buenas prácticas que deberías considerar utilizando variables.
- Utiliza nombres fáciles de leer para humanos (human-readable). Algunos buenos nombres serían por ejemplo userName, personaAge, currentDate.
- Aléjate de las abreviaciones o nombres cortos tales como a, b, c, a menos tengas una buena razón para utilizarlas.
- Asegúrate de ser lo suficientemente conciso con el nombre de las variables. Nombres como data, value, key, counter, number, array casi siempre son malos nombres.
- Los nombres de variables compuestos deberían poderse leer de manera natural bien sea utilizando camel case como en userName o snake case como en user_name.
- No utilices una misma variable para distintos propósitos en la misma sección de código. Reutilizar variables por lo general es una mala práctica, en vez de esto, se debería crear una variable diferente para cada propósito.
- Aunque el lenguaje en cuestión lo permita, no deberías utilizar caracteres no ASCII para nombrar variables.
- Utiliza sustantivos o adjetivos para nombrar las variables en lugar de verbos. Para mostrar el resultado de una validación sería mejor validation en vez de validate. Así mismo para identificar la instancia de un validor lo correcto sería validator y no validate. Existen excepciones a la regla, ya las veremos más adelante.
- Ser demasiado descriptivo también es un problema. Procura el nombre de tus variables no supere los 50 caraceteres.
- Se consistente con el nombre de las variables y la cantidad de elementos que en ella se guardan. Un array que contiene varias instancias de un objeto usuario debería llamarse users y no user.
- Utilizar is, has, can para expresar un valor booleano suele ser una buena práctica. Una variable que guarde un permiso sobre un usuario podría ser canRead o canWrite. Si quisieramos saber si un usuario está habilitado podríamos utilizar el nombre de variable isEnabled o si quisieramos saber si un artículo en un blog tiene comentarios podríamos utilizar hasComments.