Herramienta de software
Un generador de documentación es una herramienta de programación que genera documentación de software destinada a programadores ( documentación API ) o usuarios finales ( guía del usuario final ), o ambos, a partir de un conjunto de archivos de código fuente y, en algunos casos, archivos binarios . Algunos generadores, como Javadoc , pueden utilizar comentarios especiales para impulsar la generación. Doxygen es un ejemplo de un generador que puede utilizar todos estos métodos.
Tipos de generación
La generación de documentos se puede dividir en varios tipos:
- Generación de lotes (técnica genérica)
- Correspondencia de bloques de texto (documentos creados a partir de bloques de texto predefinidos)
- Formularios (formularios para sitios web)
- Síntesis de la documentación:
- La documentación se puede inferir del código.
- La documentación se puede inferir a partir de los rastros de ejecución [1]
Algunos entornos de desarrollo integrados proporcionan acceso interactivo a la documentación, metadatos del código, etc.
Véase también
Referencias
- ^ Zhang, Sai; Zhang, Cheng; Ernst, Michael (2011). "Inferencia de documentación automatizada para explicar pruebas fallidas" (PDF) . 2011 26th IEEE/ACM International Conference on Automated Software Engineering (ASE 2011) . págs. 63–72. doi :10.1109/ASE.2011.6100145. ISBN . 978-1-4577-1639-3.S2CID14846118 .
