Tras la Guía del desarrollador: Nomenclatura I, seguimos con esta serie de artículos, profundizando en las leyes de una buena nomenclatura. Esta vez, tras ver la primera ley y sus corolarios, vamos a avanzar un poco más en esas buenas prácticas que podemos llevar a cabo sin mucho esfuerzo.
Segunda ley de la nomenclatura: Evita nombres que creen confusiones.
Normalmente entendemos la comunicación a través del lenguaje como un arte impreciso. Tendemos a quedarnos con la comprensión del concepto general sin detenernos en los matices que proporciona esa palabra concreta en lugar de una de significado similar ¡Pero no! Debemos entender que el significado importa y el lenguaje, tanto oral como escrito, puede ser preciso como una fórmula matemática.
Es posible que en esos matices que descartamos, esté la clave de un concepto y, en programación, eso es un lujo que no podemos permitirnos.
Si a una variable la declaramos con un nombre bookSet esa estructura ha de ser un mapa, que contenga objetos de tipo book y que sea un set (conjuntos o colecciones donde no existen elementos duplicados por definición). No podrá ser una lista, ni una pila, ni un mapa, debe ser un conjunto ya que, las características y funciones que estamos anunciando en su nombre, tienen relevancia en la programación.
Aún así, es recomendable no utilizar como parte del nombre de estas variables el tipo de estructura que es, pudiendo usar bookGroup o simplemente books como nombre final.
Pero igual que hemos dicho que los detalles importan, debemos ser conscientes de que no se trata de esconder esos detalles. Si hay variaciones en los nombres, deben tener lógica y significado, no debemos complicar la lectura al programador. Por ejemplo, supongamos como dadas estas dos variables:
bigDataStructureHandlerForParsingData y bigDataStructureStorerForParsingData.
Son dos nombres, que aunque definan correctamente el concepto que representa, necesitan de un tiempo extra de lectura para ser diferenciadas.
También debemos intentar evitar nombres de variables que tengan grafismos similares, especialmente i, O, 1 o 0.
Insistimos: ¡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.