Estándares de codificación

Miguel Orquera
Lograr un código comprensible
• “Vamos a cambiar nuestra actitud tradicional en la construcción de los
programas: en lugar de imaginar que nuestra tarea principal es la de
instruir a un ordenador qué hacer, vamos a concentrarnos más en explicar
a los seres humanos lo que queremos que una computadora haga.” Donald
Knuth. "Programación literaria (1984)"
El programador, con el diccionario de sinónimos en la mano, debe elegir los
nombres de las variables con cuidado y explicar lo que significa cada
variable. Él debe esforzarse por lograr un programa que sea comprensible,
introduciendo sus conceptos en el orden que es mejor para la comprensión
humana, utilizando una mezcla de métodos formales e informales que se
refuerzan mutuamente.
El editor y el lenguaje de programación
• Para escribir buen código se necesita un lenguaje de programación y un buen
editor de texto (formateador) que permita mediante tipos de letra, colores,
resaltadores y tabuladores clarificar el código que se escribe.
• La estructura de un programa de software puede ser pensado como una "red"
que se compone de muchas piezas interconectadas. Para documentar este
programa se debe explicar cómo se relaciona con sus vecinos cada parte
individual de la red. Las herramientas tipográficas proporcionadas por el editor de
texto nos permiten explicar la estructura local de cada parte, y las herramientas
proporcionadas por el lenguaje de programación hacen posible que se
especifiquen los algoritmos formalmente y sin ambigüedades. Mediante la
combinación de los dos, se puede desarrollar un estilo de programación que
maximice nuestra capacidad para percibir la estructura de una compleja pieza de
software, y al mismo tiempo los programas documentados pueden ser traducidos
mecánicamente en un sistema de software que funciona como lo dice la
documentación.
La programación literaria
• La programación literaria genera programas escritos para ser leídos
por otros desarrolladores de software. La comprensión del programa
es una actividad clave durante el mantenimiento correctivo y
perfectivo. La documentación de alta calidad facilita la modificación
del programa con menos errores conceptuales y menos defectos. La
claridad de los programas permite a los miembros del equipo
reutilizar código existente y proporcionar retroalimentación
constructiva durante las revisiones de código.
Organización del código fuente en pequeñas
secciones.
• El estilo de programación literaria combina código fuente y la
documentación en un solo archivo fuente. Los programas resultantes
utilizan secciones que permiten al desarrollador describir bloques de
código de una manera conveniente. Las funciones se descomponen
en varias secciones. Las secciones se presentan en el orden que es
mejor para la comprensión del programa. Cada sección del código
mejora su comprensión, escribiendo párrafos descriptivos y evitando
que se sature el código fuente.
Elaboración de un listado de programa con la
calidad de un libro
• Los lenguajes de programación literarios utilizan una combinación de
lenguaje de composición y lenguaje de programación. El lenguaje de
composición contiene todas las ayudas disponibles en los libros, tales
como imágenes, diagramas, figuras, tablas, referencias bibliográficas,
tablas de contenido e índices. El tratamiento tipográfico de los
programas literarios produce listados de código con la documentación
elegantemente formateada y el código fuente. Los listados generados
en formato PDF incluyen enlaces de hipertexto.
Recomendaciones al escribir código
• Hay muchos factores que intervienen en el desarrollo de excelente
software. Programación literaria es sólo una de las técnicas para ser
utilizadas junto con las otras prácticas de ingeniería de software bien
establecidos. Estas son algunas de las prácticas de software relacionados
con la documentación del programa:
• Establecer estructuras, procesos y resultados.
• Generar los requisitos de software y descripción del diseño.
• Elegir sabiamente los nombres de clases, funciones y variables.
• Evite código duplicado mediante la creación de funciones compartidas.
• Re-pensar o refactorizar código que es difícil de entender.
• Desarrollar clases y funciones pequeñas cuando sea posible.
• Debe ser sencillo y directo tanto como sea posible.
Recomendaciones al escribir código
• Comentar el código fuente en cabeceras y en cada línea.
• Código fuente del documento usando un estándar de documentación.
(Analizar el software doxygen). Proporcionar pruebas formales o informales
para la corrección de código fuente.
• Llevar a cabo revisiones por pares de los entregables.
• Implementar pruebas unitarias automatizadas que es también una forma de
documentación. (Ver cppunit).
• Examinar métricas de código fuente (líneas, complejidad, etc.).
• Ejecutar análisis estático de los errores comunes de codificación.