Foros del Web » Creando para Internet » Diseño web »

Documentar código

Estas en el tema de Documentar código en el foro de Diseño web en Foros del Web. 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 ...
  #1 (permalink)  
Antiguo 21/03/2008, 11:10
 
Fecha de Ingreso: noviembre-2004
Mensajes: 92
Antigüedad: 13 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?.
  #2 (permalink)  
Antiguo 22/03/2008, 03:53
Avatar de Raulmmmm  
Fecha de Ingreso: marzo-2007
Ubicación: En otro lugar que tú
Mensajes: 1.549
Antigüedad: 10 años, 8 meses
Puntos: 36
Re: Documentar código

Pues si quieres otros formatos para documentar en vez del de Word, puedes usar Wordpad (guárdalo como .rtf) o el Bloc de Notas, que vienen incluidos en Windows XP, en los que ocupan muy poco espacio.
  #3 (permalink)  
Antiguo 25/03/2008, 14:17
 
Fecha de Ingreso: noviembre-2004
Mensajes: 92
Antigüedad: 13 años
Puntos: 0
Re: Documentar código

Conozco las herramientas para crear documentos externos al código que facilitan los sistemas operativos. Y se usar plantillas predefinidas para crear estos documentos, e incluso crear base de datos Lotus Notes para estos cometidos.

Pero entiendo que la web es un entorno más ligero y lo que necesito es saber si el hecho de usar herramientas tipo Doxygen, NaturalDocs que generan la documentación automaticamente desde el código fuente, penaliza la carga de estos ficheros del servidor al navegador, de modo que sean opciones a no usar.

Si fuera así, querria saber si usais algún tipo de alternativa.
Atención: Estás leyendo un tema que no tiene actividad desde hace más de 6 MESES, te recomendamos abrir un Nuevo tema en lugar de responder al actual.
Respuesta




La zona horaria es GMT -6. Ahora son las 15:25.