Clean Code: Capítulo 2

Nombres con significado

Si a la hora de nombrar una variable, clase o método también es necesario añadir un comentario que explique qué hace o para qué sirve, ese nombre puede cambiarse por uno mejor. En otras palabras, los nombres deben ser auto descriptivos.

Además, otras características deseables son que los nombres:

• Sean fácilmente distinguibles entre sí
• Sean pronunciables. Los nombres difíciles de pronunciar entorpecen la fluidez de las conversaciones sobre el código.
• Sean fácilmente localizables. Al leer un código, se ubicará más rápido una constante “HOURS_WORKED_PER_DAY” que un 8.
• No contengan su tipo u otros términos específicos del lenguaje
• No sean una sola letra (excepto bucles, por tradición)
• Sustantivos si se está nombrando una clase
• Verbos si se está nombrando un método

Nuestro objetivo como programadores es que nuestro código sea lo fácil de leer posible. Aunque lo escribimos para que sea ejecutado por una máquina, otros compañeros de equipo también tendrán que leer nuestro código, así como nosotros leeremos el código de otros compañeros.