50251_es-ES

liliconcom

Documentación del código fuente

Actualmente utilizo NaturalDocs para generar automáticamente la documentación basada en HTML del código JSL que escribo.  Funciono bastante bien con un simple marcado de comentario dentro del código:

 

Actualmente estoy configurando un nuevo entorno de desarrollo y es una oportunidad para revisar las herramientas dentro de mi flujo de trabajo.  Me pregunto si alguien tiene alguna otra opinión sobre las herramientas de generación de documentación para JSL.

 

Re: Documentación del código fuente

Acabo de instalarlo en una PC nueva: adjunto es una descripción del proceso

Re: Documentación del código fuente

@uday_guntupalli Voy adelante y lo instalo en una computadora nueva.  Me complace documentar y compartir el procedimiento una vez que se complete (tuve que extender la configuración para manejar el lenguaje JSL).

Re: Documentación del código fuente

@David_Burnham ,
Intenté seguir el ejemplo e instalar Natural Docs. Después de configurarlo como se detalla aquí ( http://www.naturaldocs.org/getting_started/getting_set_up/#starting_a_new_project ), cuando intento ejecutar configure para generar documentación, obtengo lo siguiente

Sin embargo, según las instrucciones, proporcioné la carpeta de entrada y la carpeta de salida. ¿Alguna idea sobre lo que hice mal? 

 

 

Re: Documentación del código fuente

NaturalDocs se ve muy interesante.  ¡Gracias por hacernos conscientes de ello!

 

Una pequeña parte de esta discusión: aquí hay algunas utilidades de código abierto que me parecen indispensables para el desarrollo del programa:

TortugaSVN : H Los programadores de elps gestionan diferentes versiones del código fuente para sus programas (sistema de control de código fuente).  Apache ™ Subversion (SVN) ® cliente, implementado como una extensión de shell de Windows.

Bloc de notas ++: Bloc de notas de Windows en los esteroides.  Sintaxis de colorización para la mayoría de los idiomas.

Kdiff3: Programa de diferencia basado en Windows.  Ideal para encontrar y combinar diferencias entre dos o tres archivos o directorios. 

 

 

Re: Documentación del código fuente

Comencé por este camino con DOxygen (uso un spin off, roxygen2, extensivamente en R) pero no conseguí lo suficiente para implementar nada con JSL. NaturalDocs parece un buen ajuste.