|
Me acordé cuando leí el comentario de Delphius de cuando en la universidad presenté un proyecto en un concurso (el cual por fortuna gané) y utilcé el modelo COCOMO para estimar los costos del mismo en caso de comercializarlo. Eran por ahí del '94 cuando lo hice y ni siquiera era Delphi. Ahora ya está en desuso ese modelo, con el advenimiento de la OOP y las enseñanzas de Don Grady Booch.
Delphi-To-Doc es bueno pero a mi juicio no iguala la calidad y facilidad de JavaDoc donde el propio IDE que utilices (Eclipse o Netbeans) reconoce los comentarios y te proporciona recordatorios de parámetros y demás cosas, simplemente no he encontrado algo parecido.
Al final, la documentación tiene como función principal explicar lo que el código hace, como lo hace y por qué lo hace así.
Lo que si es muy importante es estandarizar detalles en el estilo: Usar o no CamelCase, o subrayados, definir índices de ciclos a partir de "i,j,k..etc.", no utilizar variables de una sola letra, utilizar constantes siempre que un valor se repita más de una vez y colocarlas en una sola unidad para poder tenerlas a la mano en cualquier momento, etc.
|