21/03/2008, 10:10
|
| | | Fecha de Ingreso: noviembre-2004
Mensajes: 92
Antigüedad: 20 años Puntos: 0 | |
| Documentar código
Tengo dudas de como generar documentación del código js y php que componen los proyectos webs en los que estoy trabajando.
La idea es usar un método ligero, y no realizar la documentación en documentos word ajenos al código. Esta documentación estaría dedicada más bien en forma de API, es decir, para que valdría cada clase, método, función, etc. De cara a documentar como está construido todo (en plan cuaderno de carga) si que creo que lo mejor es hacerlo sobre un documento a parte.
De las herramientas de generación de documentación he probado con NaturalDocs, ya que creo que es la única que soporta js y php, pero no me convence el hecho de documentar junto con el código, ya que por ejemplo con el js haría que el fichero pesara más, y perjudicaría la carga de la página desde el servidor. ¿Pasaría lo mismo con el php?.
¿Existe alguna alternativa similar a estos generadores de documentación? o ¿lo que pueda añadir a los ficheros de comentarios para la generación de la documentación no va a perjudicar considerablemente la carga de estos desde el servidor?. |