Documentación del código fuente
Son herramientas que a partir de un análisis previo del código fuente generan la documentación del mismo. Para ello es necesario que el código fuente cumpla con un determinado estándar para generar la documentación.
De acuerdo a la tabla doxygen y robodoc se presentan como las alternativas más adecuadas para la generación de documentación técnica por los lenguajes soportados y formatos de salida, son fáciles de instalar, ambas se pueden descargar de los repositorios de Debian.
Sin embargo estas dos herramientas presentan una considerable diferencia es los estilos para comentar el código fuente. En donde RoboDoc es poco flexible
La elección es Doxygen ya que es una excelente herramienta a la hora de extraer la documentación a partir de los comentarios para crear documentación consistente.
Herramienta |
Licencia |
Sistema operativo |
Lenguaje soportados |
Lenguaje utilizado para su desarrollo |
Formatos de salida |
Doxygen |
GPL |
Linux, windows |
C/C++, java, php, python |
C++ |
html, chm, rtf, pdf, latex, PostScript, man pages, xml |
GPL |
Linux, windows |
Perl |
html |
||
Natural Docs |
GPL |
Linux, windows |
C/C++, java, php, python, ruby, javaScript,(todos los anteriores de manera parcial), perl |
Perl |
html |
phpDocumentor |
LGPL |
Linux, windows |
Php |
Php |
html,chm,pdf,docbook,xml |
ROBODoc |
GPL |
Linux, windows |
C/C++, java, php,perl,python,ruby,JavaScript |
C |
html, chm, rtf, pdf, latex, PostScript, man pages, docbook |
Tabla 6: Comparación de Herramientas para Documentación Técnica