Introducción

En el mundo de la programación, elegir nombres adecuados es esencial para escribir código limpio y mantenible. Basándonos en el capítulo «Naming» del libro «Clean Code» de Robert C. Martin, exploramos las claves para elegir un buen nombre, esenciales para cualquier desarrollador que busque optimizar su código para una mejor comprensión y mantenimiento.

La importancia de elegir un nombre correcto

Elegir un nombre que revele claramente las intenciones es vital para facilitar la comprensión a futuro, aunque lleve más tiempo elegirlo.

Una buena forma de detectar si un nombre es bueno o no, es ver si es necesario un comentario para explicarlo. Si es así, significa que no revela su cometido.

Cómo evitar la desinformación en los nombres

Evita nombres que induzcan a confusiones, como el uso de letras que se parezcan a números.
Prioriza los nombres claros y distintivos para evitar malentendidos.

Distinciones significativas en los nombres

Cada nombre en tu código debe tener un propósito claro. Evita redundancias y asegúrate de que cada palabra aporte valor.

Utiliza nombres que se puedan pronunciar y buscar

Un nombre fácil de pronunciar y buscar mejora significativamente la mantenibilidad del código.

Si no eres capaz de pronunciar un nombre, no podrás explicarlo sin parecer tonto.

Si utilizas letras sueltas o abreviaturas, será mucho más complejo localizarlas.

Evita las codificaciones en los nombres

Evita utilizar métodos de codificación en los nombres, como la notación húngara porque no son ideales en el contexto actual.

Lo mismo ocurre con las interfaces e implementaciones. No es necesario añadir el sufijo «Interface» a una interfaz, ya que el IDE te lo indicará.
Además, es mejor codificar la implementación que la interfaz.

Evita asignaciones mentales

Por ejemplo, no utilices una letra como nombre de variable (excepto en contadores de bucles), ya que hay que asignar mentalmente lo que significa.
La claridad es lo importante para que otros programadores puedan entender el código.

Consejos para nombres de clases y métodos

Los nombres de clases no deben ser verbos, sino sustantivos o frases sustantivas.
En cambio, los métodos sí deben ser verbos y deben de expresar la acción que puede realizar dicha clase.

Claridad vs Creatividad en los nombres

No hay que ser creativo a la hora de elegir nombres, sino claro y conciso.

Defina un lenguaje de dominio y utilícelo siempre

Es importante definir una palabra por cada concepto y mantenerla durante todo el proyecto. Eso facilitará la comunicación con el resto del equipo.

No utilices la misma palabra con dos significados distintos.

Añadir contexto adecuado

Si fuese realmente necesario para clarificar el código y añadir contexto, se pueden usar prefijos.

Es importante no añadir contextos innecesarios, como el nombre de la empresa o el producto.

Conclusión

Nombrar adecuadamente es crucial para escribir código limpio y mantenible. Siguiendo estas pautas, los programadores pueden mejorar significativamente la legibilidad y eficiencia de su código, y se reducirán los problemas con el resto del equipo.

¿Qué te parecen estos consejos? ¿Los aplicas en tu código?

Si tenéis cualquier duda podéis poneros en contacto conmigo enviando un DM por twitter.