ElZorro

La legibilidad es uno de los criterios más destacados a la hora de decidir si un programa es bueno o no, el motivo es sencillo, la legibilidad es la llave para la comprensión de un programa y los programas que no se puedan comprender no podrán ser modificados ni se les podrá dar mantenimiento, por lo que tendrán poco valor, incluso el mismo autor de un programa, tendrá dificultadas para recordar lo que hacía un programa y la forma de hacerlo después de un cierto intervalo de tiempo, en el formato y la apariencia de un listado de un programa es donde más se puede hacer por mejorar la legibilidad del mismo, en general, el objetivo debe ser hacer el programa más legible, comprensible y fácilmente modificable, para alcanzar este objetivo existe una serie de elementos de estilo que sirven de guía para producir programas de forma correcta, estas consideraciones de estilo se deben tener en cuenta desde el diseño del algoritmo, los principales elementos de estilo son:
1. Comentarios: constituyen el principal exponente en la documentación interna de un programa, sirven para ayudar al lector a comprender el propósito y funcionamiento de determinadas secciones de código, en el uso de los comentarios hay que tener en cuenta varios aspectos:
• Comentarios no adecuados pueden deteriorar un buen código mientras que buenos comentarios no pueden hacer mucho para mejorar una mala codificación.
• Departamento de Informática 65
• Metodología y Tecnología de la Programación
• La abundancia de comentarios aumenta la confusión.
• Los comentarios y el código deben estar de acuerdo, cuando se realiza una modificación en el código debe realizarse un cambio similar en cualquier comentario relacionado, evitando así incoherencias con el código, en general, es deseable utilizar comentarios en los siguientes lugares:
• En las declaraciones de variables, comentando el uso de cada variable.
• En las estructuras de control, explicando la función que realizan.
• En las llamadas a programas, para explicar su función y los efectos que realizan sobre los argumentos.
• En la lista de parámetros de los subprogramas, comentando la función de cada uno de ellos y qué valores puede o no tomar.
• En las zonas de código no obvio, es decir, en cualquier parte del algoritmo o del programa que sea confuso y complicado de entender.
2. Código autodocumentado: los identificadores de un programa deben tener significado, es decir, su nombre debe ser representativo de los valores que almacenan o del procesamiento que realizan, así, es mejor nombrar a una función que obtiene la nota media de las calificaciones de varios alumnos como Obtener_Nota_Media, que utilizar otro nombre como ONM, o simplemente A.
3. Formateado del código: se basa fundamentalmente en el uso de espacios en blanco para indentar sentencias dentro de las estructuras de control tales como bucles o bifurcaciones y el uso de líneas en blanco para separar unidades lógicas dentro del código, esto aumentará la legibilidad del código.
4. Uso de constantes: permitirá ofrecer una mayor legibilidad al código, a la vez que facilidad de modificación, por ejemplo, el valor constante 3.1415 en un código, probablemente no aporte información sobre lo que representa, sin embargo el identificador PI sí, además, si quisiéramos cambiar el valor 3.1415 en todo el programa, tendríamos que buscar cada una de las ocurrencias del valor constante en el algoritmo o programa y modificarlas, con la utilización de la constante PI en el algoritmo o programa, sólo será necesario cambiar el valor en la inicialización de la constante.