La documentación interna son los comentarios que se encuentran junto con el programa fuente y son ignorados por el compilador. Se usan para describir cosas significativas para un programador: qué hace cada sección, quién lo programó, etcétera.
Comentar a medida que se escribar el programa. Preparar una parte de la documentación antes de empezar. Modificar la documentación a medida que se modifica un programa.
El primer elemento de documentación es el código. Un buen código ya es una guía, mientras una gran cantidad de comentarios no rescata un mal código. Los cuadros 5-4, 5-5, 5-6 y 5-8 muestran varios ejemplos de programas comentados.
Los comentarios generales de un programa son:
a) Encabezado del programa o módulo. b) Convención utilizada para abreviaturas. c) Límites de cada sección importante. d) Variables, constantes, procedimientos y funciones. e) Funcionamiento y parámetros requeridos por cada módulo. f) Funcionamiento detallado de los trucos. Gracias a Noelia Emilia Fernández por colaborarnos este artículo para ser publicado en ARQHYS.com…
