Hola, como estas? En este post voy a darte 5 tips rápidos que son los que me han servido para saber cómo nombrar mis variables a la hora de escribir código.

Si te acomoda más también hice un pequeño video explicando esto:

O si prefieres escucharlo rumbo al trabajo o de regreso a casa, también esta el podcast:

El nombre de las variables

Como te lo mencioné en el video, seguramente esto lo has llegado a escuchar en varias ocaciones, y es que seguramente te has encontrado con código incomprensible alguna vez, código que te "tocó mantener".

Pero déjame preguntarte algo primero ¿Alguna vez has escrito código en un proyecto/sección/componente donde solo estas tu trabajando en ello y al momento de escribir variables dices "Claro que es comprensible, lo es para mi, yo se que 'x' aquí significa tal cosa, 'mElement' se refiere a aquello 'e' por supuesto quiere decir esto, al fin solo yo lo mantengo, solo tiene que ser comprensible para mi"?.

O ¿Alguna vez llegaste a pensar "si le pongo tal nombre estará muy largo mejor la abrevio como "FLDSMDFR", "se me acabo la creatividad para los nombres, le voy a poner algo aleatorio", "creo que este nombre estará chistoso aquí, si alguien lo lee se cagara de risa", "le voy a dar mi estilo, voy a usar variables con nombres de animales", "este objeto siempre será tal cosa, mejor lo nombre como lo que es"?

Déjame decirte que pensar este tipo de cosas es un error, pues ¿Qué crees que fue lo que pensó el que escribió el código con el que ahora tú tienes que lidiar?

Y es que de eso se trata escribir buen código, ser buen coder o programador (y persona), escribir código de calidad, código limpio, se trata de no ser egoístas, así es, probablemente te moleste que te lo diga, pero deja de ser egoísta al escribir tu código. Debemos ser más empáticos a la hora de escribir código, ser conscientes que alguien más lo leerá.

No se si creas en alguna religión, si seas agnóstico o ateo, pero seguro debes de conocer la palabra "Karma", y esque si no dejamos de ser egoístas entre nosotros, el karma siempre nos perseguirá, si hacer no haces buen código, seguro llegara un momento donde tengas que mantener el "mal código" de alguien, o incluso el Karma en su máxima expresión es cuando fuiste egoísta al escribir código y ni tu mismo lo entiendes cuando tienes que darle mantenimiento a alguna clase que tu mismo escribiste tiempo atrás.

Ese es mi mayor consejo respecto a esto, sin embargo te voy a dejar un par de tips para mejorar la escritura de tu código:

1. Escribe código en ingles. No quisiera entrar en discusión sobre si es "poco patriótico" o sumisión ante los hablantes anglosajones, pero la verdad es que escribir el nombre de las variables y/o funciones en español o múltiples idiomas se ve mal, "descoordinada" con la propia sintaxis de los lenguajes de programación, y puede ser confuso. Y si piensas colaborar con equipos grandes o quieres trabajar en empresas internacionales o hacer open source, vas a terminar escribiendo código en ingles. Esto te puede sonar lógico, pero creeme, todavía hay mucha gente que escribe código en español.
2. No abrevies. Probablemente para ti "TVC" puede significar "table view component", pero piensa que eres nuevo en el equipo y no tienes mucho contexto ¿Sabrías qué significa una variable con el nombre "TDMN" ?  No abrevies y escribe el nombre completo. La única excepción donde valdría la pena abreviar y eso a veces, es al usar el clásico 'i' o 'j' en los loops para el contador, pues es conocido y universal, o al hacer un 'map' corto  por ejemplo 'elements.map(e => e.name)', es claro que e significa un ítem elemento dentro de la lista de elementos.
3. No agregues "basura" al nombre. Trata de no agregar artículos, tipos, prefijos innecesarios. Por ejemplo que diferencia hay entre "theTableComponent" a "tableComponent", el articulo "the" esta demás. Los editores ya están bastante avanzados, por ejemplo con TypeScript y el IntelliSense de VS Code te avisa y muestra que tipo de variable estas manipulando, no es necesario que agregues el tipo al nombre como "nameStr" el "Str" está demás. En una clase llamada "User", llamar las propiedades como "userName", "userAddress", está demás, la clase ya da el contexto, "user.name".
4. No intentes ser gracioso. Evita hacer cosas como poner nombres de personas, animales, bocadillos o cualquier otro sustantivo a tus variables para tratar de ser "gracioso" o darle "tu toque personal" al código. Evita poner expresiones, onomatopeya o groserías innecesarias a los nombres como "theFknUser", "blowUpEverything".
5. Sigue estándares y sé congruente. Por ejemplo en lenguajes tipados es común usar prefijos de 'get' y 'set' en los métodos junto con el nombre de la propiedad para obtener o cambiar el valor, o usar 'is', si es de tipo booleano. Usa una sola palabra para referirte a un concepto en todo el código, por ejemplo si vas a hacer peticiones evita usar en unas funciones o métodos el prefijo 'get', en otras 'fetch' y en otras partes 'request' o 'load', 'list', etc...

Lo dejaré hasta aquí, espero que haya sido de tu agrado esta información y que no haya resultado muy larga ya que personalmente me gusta mantener los posts cortos, ya que quiero aportar información concreta y concisa, sin expandirme mucho y desviarme del tema principal, ya que pienso que en esta era en la que vivimos es crucial poder obtener información rápida, eficaz y de calidad, como artículos que se leen en un par de minutos.

Espero haberte ayudado, si tienes alguna pregunta o comentario no dudes en comentar o escribirme por FB Messenger, me encuentras como @diegod3v, al igual que en mis otras redes sociales (Twitter, Instagram, LinkedIn, TikTok) y no olvides suscribirte a mi canal de Youtube.