Retroceder   Foros del Web > Diseño de Sitios web > Web general

Respuesta
 
Herramientas Desplegado
Antiguo 21-mar-2008, 11:10   #1 (permalink)
iPunto ha deshabilitado el karma
 
Fecha de Ingreso: noviembre-2004
Mensajes: 69
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?.
iPunto está desconectado   Responder Citando
Antiguo 22-mar-2008, 03:53   #2 (permalink)
Raulmmmm tiene algunos puntos positivos de karma
 
Avatar de Raulmmmm
 
Fecha de Ingreso: marzo-2007
Ubicación: En otro lugar que tú
Mensajes: 1.414
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.
Raulmmmm está desconectado   Responder Citando
Antiguo 25-mar-2008, 14:17   #3 (permalink)
iPunto ha deshabilitado el karma
 
Fecha de Ingreso: noviembre-2004
Mensajes: 69
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.
iPunto está desconectado   Responder Citando
Respuesta

No hay votos aún.


Herramientas
Desplegado

Normas de Publicación
No puedes crear nuevos temas
No puedes responder temas
No puedes subir archivos adjuntos
No puedes editar tus mensajes

BB code is Activado
Caritas están Activado
[IMG] está Activado
Código HTML está Desactivado


La Zona horaria es GMT -6. Ahora son las 20:15.


Message Board Statistics

LinkBacks Enabled by vBSEO 3.1.0

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96