Documentación

 

Enfoques de documentación moderna de software

En el trabajo de desarrollo, damos gran importancia a una documentación transparente del código de fuente del programa. Los identificadores de variables, clases y métodos son evidentes. La estructura se manifiesta claramente desplazando de forma adecuada las estructuras de control.

 

Comentario del código de fuente

La documentación se integra en la mayor medida posible en el código de fuente. Esto tiene lugar a través de renglones de comentarios en las inmediaciones de las correspondientes instrucciones en el código de fuente y que en el caso de un cambio de las instrucciones se actualizan inmediatamente.

 

Complementación del comentario

En caso de que notas, croquis y semejantes no se pueden integrar directamente en el código de fuente, se archivan por separado y se distribuyen junto con los ficheros del código de fuente para que estén a la disposición de todos los desarrolladores y no se produzcan inconsistencias.