Un generador de documentación es una herramienta de programación que genera documentación de software destinada a programadores ( documentación de API ) o usuarios finales ( guía de 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 documentación:
Algunos entornos de desarrollo integrados proporcionan acceso interactivo a documentación, metadatos de código, etc.
Referencias
- ^ Bruch, Marcel; Mezini, Mira; Monperrus, Martín (2010). "Directivas de subclasificación minera para mejorar la reutilización del marco" . 2010 Séptima Conferencia de Trabajo de IEEE sobre repositorios de software de minería (MSR 2010) . págs. 141–150. doi : 10.1109 / MSR.2010.5463347 . ISBN 978-1-4244-6802-7.
- ^ Zhang, Sai; Zhang, Cheng; Ernst, Michael (2011). "Inferencia de documentación automatizada para explicar las 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.
- ^ Gallinas, Stefan; Monperrus, Martin; Mezini, Mira (2012). "Extracción semiautomática de preguntas frecuentes para mejorar la accesibilidad del conocimiento del desarrollo de software" . 2012 34º Congreso Internacional de Ingeniería de Software (ICSE) . págs. 793–803. arXiv : 1203.5188 . doi : 10.1109 / ICSE.2012.6227139 . ISBN 978-1-4673-1067-3.