Crear Documentación de un Proyecto
22 de septiembre de 2008 | Autor: patripe
Cuando nos planteamos cualquier proyecto de programación la primera cosa que hay que tener en cuenta, es la continuidad del proyecto, puede que en un futuro el proyecto lo lleve otra persona, y comprender la programación de otros a veces es muy dÃficil. Para el trabajo en equipo resulta una condición indispensable tener una generosa documentación de un proyecto.
Crear documentación de un proyecto
Doxygen es un programa de libre distribución que nos puede ayudar mucho en esto. Entre sus principales caracterÃsticas:
- Multiplataforma
- Libre Distribución (Licencia GNU/GPL)
- Excelente documentación para desarrolladores (…)
Se puede utilizar para documentar código escrito en:
C, C, Java, Objective-C, Python, IDL (CORBA y variedades de Microsoft), Fortran, VHDL, PHP, C #.
Entre otras maravillas doxygen puede generar la documentación a partir de código de fuente comentado.
Aquà podéis ver un ejemplo.
Puedes extraer la estructura de código fuente sin comentar, incluye esquemas relacionales, dependencias, jerarquÃas…
Puedes hacer documentación en lÃnea. (Para crear un manual)
Enlaces relacionados: http://www.doxygen.org/
Publicado en Desarrollo Web, Esenciales [Desarrollo Web] | 
Etiquetas: api, código, documentación de un proyecto, doxygen, estructurar código, fuente, generador api, libre, libre distribución, manual documentación, programación
Saludos! He montado un salon recreativo… muchos me direis que en buena hora!!! con esto de la crisis digo jajaja…
Weno a lo que iba, queria una web del salon para promocion y esas cosas. Buscando encontre este sitio de desarrollo web y tiene bastante buena pinta. La verdad es que de esto entiendo bastante poco y me gustaria a ver si me dariais vuestras opiniones sobre ellos. A ver que os parece… en cuestion de precios he preguntado y estoy contento, por aqui en bilbao parece que es de lo mejor.
Un saludo y espero vuestras respuestas.
Hola Txema:
Personalmente no los conozco, ni he trabajado con ellos, pero he curioseado en la página y tienen trabajos realmente buenos (doble y triple A, CSS, lo que no me motiva tanto es asp y .net, pero también utilizan php). Supongo que eres de Bilbao, y el servicio cuanto más cerca mejor, además que te aseguren el posicionamiento es un punto a favor. Lo de estar en crisis es relativo, para los chinos significa en el peligro se encuentra la oportunidad, asà que igual es el mejor momento. Suerte.
[...] del código (además de la separación de código, estilos y elementos gráficos, y abundante documentación del proyecto), permite un mantenimiento menos costoso, y una implementación o migración mucho más sencilla, [...]