Yo he votado ambas cosas y he de decir, que por motivos de obligado cumplimento, los comentarios los realizo antes de escribr código y para más inrí, lo debo de escribir para cada uno de los procedimientos eventos funciones que se escriban. Tengo un Code Insight con el formato que se debe rellenar de documentación. Sí os soy sincero y despues de cuatro años teniendo que realizar esta ardua tarea, tengo que reconocer que apenas se pierde tiempo siempre y cuando lo primero que se haga sea documentar.
Otro canto os cantaria cuando se debe hacer despues de escribir un programa.
Os paso un pequeñito ejemplo para que os hagais una ligera idea de como es la documentación ha realiar.
{
*Documentación*
*Nombre: USelVar
*Tipo: Unit
*Título: Consultas con distintos niveles y órdenes de agrupación de criterios
*Autor: AJAA INFOSERVICIOS U.S.Y.P. (Unidad de Soluciones y Proyectos)
*Descripción:
El objetivo de este módulo es facilitar al usuario un SISTEMA sencillo e
intuitivo para la REALIZACIÓN DE CONSULTAS DE ÍNDOLE ESTADÍSTICA que permita
el cruce entre diversas variables. Es posible totalizar los resultados según
diferentes criterios y órdenes relativos de agrupación, con la posibilidad de
cambiar la estructura de la consulta en tiempo de ejecución.
Dentro de cada criterio de consulta, el usuario puede definir diferentes
AGRUPACIONES o TRAMOS de valores individuales - según la naturaleza del
criterio - con respecto a los cuales se totalizarán los resultados de la
consulta. Se proporciona toda la funcionalidad necesaria para la creación y
edición de tales agrupaciones. El usuario dispone también de la posibilidad
de prescindir de tales agrupaciones personalizadas y seleccionar los elementos
particulares que figuran en los catálogos montenidos por la aplicación para
cada uno de los criterios. La enorme flexibilidad proporcionada para el diseño
de las consultas permite posibilidades de análisis de la información de gran
utilidad.
El conjunto de criterios, grupos y valores se muestra en forma de estructura
jerárquica arborescente en la parte izquierda de la pantalla. A la derecha
se presentan dos ListView's donde se visualiza el conjunto de grupos seleccio-
nados para realizar la consulta. La selección se realiza mediante drag&drop.
Cada uno de ellos se utiliza para un eje diferente (abscisas y ordenadas). El
número máximo de grupos que puede seleccionarse para el eje horizontal está
limitado por razones de espacio.
Se proporciona, finalmente, todo un conjunto de filtros ajustables por el
usuario para limitar el ámbito de la consulta.
*Modificaciones*
*Fecha:
*Autor:
*Descripción:
}