Con este post pretendo iniciar una serie de recomendaciones, no solo mías sino también de grandes gurús del mundo de la programación. Todos estos consejos aparecen recopilados en el excelente libro “Clean code” de Robert C. Martin. Así que, sin más dilación, abrimos el telón…
Primera ley de la nomenclatura: Usa nombres con sentido.
Cuando escribimos código estamos también contando una historia. Debemos tener claro que cada palabra cuenta, cada palabra debe aportar información y sentido. Establecer nombres de variables que no representen el valor que almacenan no tiene sentido.
Primer corolario: Si una variable necesita comentario, el nombre es incorrecto.
Debemos tener claro que “no nos van a cobrar por cada letra que escribamos en el nombre de una variable” y tampoco va a afectar al rendimiento de nuestra aplicación así que, establece nombres apropiados.
int d; // tiempo transcurrido en días.
int elapsedTimeInDays;
Como se observa, la información es similar, pero gracias al nombre de la variable seremos conscientes en todo momento de lo que representa esa variable.
Segundo corolario: Si un método no expresa su función, la nomenclatura es incorrecta.
Cuanto mayor es el uso de una nomenclatura incorrecta, mucho más complejo es entender ese código.
Una función o procedimiento escrito de esta manera plantea más incógnitas de las que resuelve, por lo tanto, deberemos revisarlo: ¿Qué es exactamente lo que hace? ¿A qué corresponde “theList” ? ¿Cuál es el motivo por el que se almacenan estos valores en esas posiciones?…
Con un cambio en los nombres pero no en la lógica ya se observa una mejor. Usar variables en lugar de números enteros facilita la lectura del código y aporta mucha más información. Pero aún podríamos clarificar el código creando nuestras propias clases y métodos convirtiendo nuestro código en uno mucho más legible.
Con el desarrollo de la clase Cell y los métodos isEmpty(), que comprobará que la celda está vacía, y isNextTo(Cell cell), que comprobará que se encuentra en diagonal en un margen de una celda, simplificamos el código y lo acercamos al lenguaje natural.
Recuerda: ¡La nomenclatura importa!
Si quieres ampliar tus conocimientos de programación, SEAS imparte mucha formación relacionada, como por ejemplo el Máster en Desarrollo de Aplicaciones Multiplataforma, con el que podrás aprender a gestionar y desarrollar software para escritorio, web y móvil.
SEAS es el centro de formación online del Grupo San Valero, especializado en el ámbito técnico, industrial y de empresa. Visita www.seas.es para consultar nuestra oferta formativa de cursos y másteres. Formación profesional para el empleo de calidad y accesible para todos.
