Como ya te comentaron depende de que tipo de documentación vayas a realizar, la documentación del código la puedes hacer siguiendo los consejos que ya te dieron mas lo que a ti te acomode más. Es importante mantener un estilo constante al escribir código, por ejemplo si vas a usar:
Código:
CamelCase, guion_bajo, ESTILOBASIC, BASIC_CON_GUION
Si vasa usar variables de un solo caracter para índices (i,j,k...etc.)
La mejor práctica aunque la verdad muy tediosa y digna de asignar a una sola persona para hacerla, es escribir antes de cada función, procedimiento o clase una descripción detallada de que hace, que parámetros espera y que devuelve. Casí como una miniayuda de Delphi.
Y por supuesto utilizar algun control de versiones pues llegado el caso puede sucederte que algo que funcionaba deje de funcionar por algun efecto colateral, con este tipo de sistemas podrás regresar siempre a la versión que funcionaba o bien hacer "forks" para agregar o probar funcionalidades sin echar a perder lo que ya funciona y en caso de que todo salga bien unirlo nuevamente con lo que ya tenías.
Ya el caso de la documentación que se entrega con el proyecto es muy variable pues depende de lo que el cliente quiera, si lo vas a seguir atendiendo o bien lo va a mantener su propio staff y un sin fin de cosas.
Ya no te digo cuando es una aplicación comercial...ahi si...es un buen embrollo.
Por cierto, no sé si las últimas versiones de Delphi lo traigan pero que genialidad sería que existiera algo así como JavaDoc pero para Delphi, quienes ya lo hayan probado no me dejarán mentir que es lo máximo pues te crea prácticamente una ayuda en línea de tu propio sistema mientras lo vas desarrollando.
03-05-2010
Temas Similares
Modo Hilado