2008-09-22 20 views
8

¿Hay alguna forma de generar documentos de proyecto durante compilaciones automáticas?Generar documentos en compilación automatizada

Me gustaría tener un único conjunto de archivos de código fuente (HTML?) Con el manual del usuario, y de ellos generará:

  • documento PDF
  • CHM ayuda
  • versión HTML de la ayuda

El contenido sería básicamente el mismo en los tres formatos.

Actualmente estoy usando msbuild y CCNET, pero podría cambiar eso si fuera necesario.

Respuesta

7

Sí!

  • Utilice SandCastle para compilar la documentación CHM/HTM de las API.
  • Uso DocBook + FOP y otras herramientas para producir otros tipos de documentación en PDF, RTF, HTML, etc ...

Ellos pueden ser fácilmente integrados con CruiseControl.NET través NAnt.

2

El proyecto de Apache Forrest podría ayudarlo a brindarle lo que desea.

En general, será mejor que escriba su documentación en XML. De eso deberías poder generar casi todo lo que necesites.

6

¿Has probado Doxygen? Está disponible también para Windows y debería ser fácil de integrar en cualquier script/proceso de compilación.

1

La Ayuda y el Manual pueden generar PDF, HTML y CHM (y otros formatos) de buena calidad desde una sola fuente. También tiene una interfaz de línea de comando. Tengo la versión 4 y me gusta mucho. Uso condicionales (como #ifdefs) para generar versiones de Windows y Mac de mi documentación en varios formatos como parte de un archivo .bat/.csh de compilación. La versión 5 ya está disponible.

http://www.ec-software.com/

1

Si desea de su API documentado también, y está utilizando msbuild, entonces considerar el uso de DocProject para controlar la acumulación SandCastle. (Estas herramientas no son para la documentación del usuario final ...)

0

He tenido una experiencia con Doxygen. Es agradable y fácil, pero hace que desee sobrecommentar el código para facilitar el trabajo de documentación posterior.

Cuestiones relacionadas