Las siguientes tablas comparan la información general y técnica de varios generadores de documentación . Consulte los artículos de los productos individuales para obtener más información. A menos que se especifique lo contrario en las notas al pie, las comparaciones se basan en las versiones estables sin complementos, extensiones o programas externos. Tenga en cuenta que muchos de los generadores enumerados ya no se mantienen.
Información general
Información general básica sobre los generadores, incluyendo: creador o empresa, licencia y precio.
Nombre | Creador | Formato de entrada | Idiomas | Soporte del sistema operativo | Primera fecha de lanzamiento público | Última versión estable | Licencia de software |
---|---|---|---|---|---|---|---|
COBOLDoc | Bruno Pacheco Lopes da Silva | Texto | COBOL | Alguna | 2020/08/01 | 1.0.11 | GPL |
Ddoc | Walter Bright | Texto | D | Windows, OS X, Linux y BSD | 2005/09/19 | DMD 2.078.3 | Aumentar |
¡Documento! X | Innovasys | Texto, binario | Solo C ++ / CLI, Java, C #, VB, VBScript, IDL, PL / SQL | Solo Windows | 1998 | 2014.1 | Propiedad |
Doxígeno | Dimitri van Heesch | Texto | C / C ++, Java, C #, D, IDL, Fortran, PHP, Python | Alguna | 1997/10/26 | 1.9.1 | GPL |
Epydoc | Edward Loper | Texto | Pitón | Alguna | 2002/01 / - | 3,0 (2008) | MIT |
fpdoc (Generador de documentación Free Pascal) | Sebastián Guenther | Texto | Pascal | [ verificación necesaria ] | 2005? | 2.6.4 | GPL |
Eglefino | Simon Marlow | Texto | Haskell | Alguna | 2002 | 2.15.0 (2014) | BSD |
HeaderDoc | Apple Inc. | Texto | C, C ++, Java, Delphi, Pascal, IDL, PHP, Perl, Python, Ruby, JavaScript, Tcl, AppleScript, MIG, Bash, Csh | Cualquier tipo Unix | 2000/09 / - | 8.9.28 (2013) | APSL |
Imagix 4D | Imagix Corp. | Texto | C, C ++, Java | Windows, Linux, Unix | 1995 | 7.3 | Propiedad |
Javadoc | Microsistemas solares | Texto | Java | Alguna | 1995 | 1,6 | GPL |
ScalaDoc | LÁMPARA, EPFL | Texto | Scala | Alguna | 2011 | 1.0 | Licencia Scala |
JSDoc | Michael Mathews | Texto | JavaScript | Alguna | 2001/07 / - | 1.10.2 | GPL |
Kit de herramientas de JsDoc | Michael Mathews | Texto | JavaScript | Alguna | 2007? | 2.0.0 | MIT |
mkd | Jean-Paul Louyot | Texto | Cualquiera con comentarios | Cualquiera ( [ OS X? Se necesita verificación ] ) | 1989 | 2015 | EUPL GPL |
Documentos naturales | Greg Valure | Texto | Cualquiera con comentarios | Alguna | 2003/05/26 | 2.0.2 | GPL |
NDoc | Jason Diamond, Jean-Claude Manoli, Kral Ferch | Binario | C# | Solo Windows | 2003/07/27 | 1.3.1 | GPL |
Pandoc [ verificación necesaria ] | John MacFarlane | ? | ? | Alguna | 2006 | 1.14.0.3 (2015) | GPL |
pdoc | Andrew Gallant | Texto | Pitón | Alguna | 2013 | 1.0.1 (2021) | Deslicencia |
pdoc3 | kernc | Texto | Pitón | Alguna | 2018 | 0.9.2 (2020) | Affero GPL |
perldoc | Larry Wall | Texto | Perl | Alguna | 1994 | 5.16.3 | Artístico , GPL |
phpDocumentor | Joshua Eichorn | Texto | PHP | Alguna | 2000 | 3.0.0 | LGPL para 1.x, MIT para 2+ |
Pydoc | Ka-Ping Yee [1] [2] | Texto | Pitón | Alguna | 2000 | en el núcleo de Python | Pitón |
RDoc | Dave Thomas | Texto | C, C ++, Ruby | Alguna | 2001/12/14 | en núcleo Ruby | Rubí |
ROBODoc | Frans Slothouber | Texto | Cualquiera con comentarios | Alguna | 1995/01/19 | 4.99.36 (2015) | GPL |
Castillo de arena | Microsoft | Texto | .NETO | Solo Windows | 2008/05 / - | 2014.5.31.0 | Ms-PL |
Esfinge | Georg Brandl | Texto | C, C ++, Ada, Fortran, PHP, Python, Ruby, JavaScript | Alguna | 2008/03/21 | 3.5.4 | BSD |
Experto visual | Novalys | Texto, binario | C #, PL / SQL, Transact-SQL, PowerBuilder | Solo Windows | 1995 | 2017 | Propiedad |
VSdocman | Helixoft | Texto | C #, VB, VBScript | Solo Windows | 2003 2 de octubre | 9.0 | Propiedad |
YARDA | Loren Segal | Texto | Rubí | Alguna | 2007/02/24 | 0.7.3 | MIT |
Nombre | Creador | Formato de entrada | Idiomas | Soporte del sistema operativo | Primera fecha de lanzamiento público | Última versión estable | Licencia de software |
Formatos admitidos
Los formatos de salida que pueden escribir los generadores.
HTML | CHM | RTF | Látex | Posdata | páginas man | DocBook | XML | ePub | ||
---|---|---|---|---|---|---|---|---|---|---|
COBOLDoc | sí | No | No | No | No | No | No | No | No | |
Ddoc | sí | Sí [a] | No | Sí [a] | Sí [a] | Sí [a] | Sí [a] | No | Sí [a] | |
¡Documento! X | sí | sí | No | No | No | No | No | No | No | |
Doxígeno | sí | sí | sí | Indirectamente [b] | sí | Indirectamente [b] | sí | sí | sí | No |
Epydoc | sí | No | No | sí | Indirectamente [c] | Indirectamente [c] | No | No | No | |
Eglefino | sí | sí | No | No | No | No | No | Parcial | No | |
HeaderDoc | sí | No | No | No | No | No | sí | No | sí | |
Imagix 4D | sí | No | sí | No | No | No | No | No | No | |
Javadoc | sí | Indirectamente [d] | Indirectamente [d] | Indirectamente [d] | Indirectamente [d] | Indirectamente [d] | Indirectamente [d] | Indirectamente [d] | Indirectamente [d] | |
JSDoc | sí | No | No | No | No | No | No | No | No | |
Kit de herramientas de JsDoc | sí | No | No | No | No | No | No | No | Sí + JSON | |
Documentos naturales | sí | No | No | No | No | No | No | No | No | |
NDoc | sí | sí | No | No | No | No | No | No | No | |
pdoc | sí | No | No | No | No | No | No | No | No | No |
pdoc3 | sí | No | No | Indirectamente [e] | No | No | No | No | No | No |
phpDocumentor | sí | Sí (solo 1.x) | No | Sí (solo 1.x) | No | No | No | Sí (solo 1.x) | Sí (solo 1.x) | |
Pydoc | sí | No | No | No | No | No | No | No | No | No |
RDoc | sí | Si [f] | No | No | No | No | Indirectamente [g] | No | Si [f] | |
ROBODoc | sí | Indirectamente | sí | Indirectamente [c] | sí | Indirectamente [c] | sí | sí | No | |
Castillo de arena | sí | sí | No | No | No | No | No | No | No | |
Esfinge | sí | sí | Indirectamente [h] | sí | sí | sí | ||||
Experto visual | sí | No | No | No | No | No | No | No | No | |
VSdocman | sí | sí | No | sí | No | No | No | No | sí | |
YARDA | sí | No | No | No | No | No | No | No | No | |
HTML | CHM | RTF | Látex | Posdata | páginas man | DocBook | XML | ePub |
Otras características
posibilidad de personalización ampliada | diagramas generados | resaltar y vincular el documento generado | tipos de parámetros extraídos | |
---|---|---|---|---|
COBOLDoc | sí | |||
Ddoc | con macros | |||
¡Documento! X | plantillas basadas en HTML personalizables, etiquetas de comentarios personalizadas | diagramas de relación de objetos gráficos vinculados | enlaces internos y enlaces a la documentación del marco .NET | tipos extraídos y vinculados |
Doxígeno | con XSLT | gráficos de personas que llaman y personas que llaman, gráficos de dependencia, diagramas de herencia, diagramas de colaboración | ||
Epydoc | ||||
Eglefino | sí | sí | ||
HeaderDoc | Encabezados, pies de página, colores de código y otros estilos CSS personalizados en páginas individuales. El TOC de todo el proyecto se genera a partir de una plantilla definida por el usuario. | Resaltado / coloración de sintaxis configurable con vinculación automática a los símbolos en la declaración, capacidad para vincular manualmente a los símbolos en discusión, etc. | Proporciona advertencias si los parámetros etiquetados no coinciden con el código, los parámetros analizados incluidos en la salida XML y el archivo de etiquetas estilo Doxygen (marca -D en 8.7). Soporte parcial del preprocesador de C con el indicador -p. Soporte para el control # if / # ifdef sobre la inclusión de documentación usando los indicadores de línea de comandos -D y -U. | |
Imagix 4D | personalizable a través de hojas de estilo y CSS | gráficos vinculados de jerarquía y dependencia para llamadas a funciones, conjuntos y lecturas de variables, herencia de clases e interfaz, e incluye e interfaz de archivos, diagramas de flujo intrafunción | Todo el proyecto con vínculos cruzados, incluidos todos los gráficos de jerarquía y dependencia, tablas de métricas, fragmentos de código fuente y archivos fuente | análisis semántico completo del código fuente, incluidos los tipos de parámetros, directivas de compilación condicional, macro expansiones |
Javadoc | ||||
JSDoc | sí | |||
Kit de herramientas de JsDoc | sí | |||
mkd | Personalizable para todo tipo de comentarios | 'tal cual' en los comentarios | toda la documentación general; referencias, manual, organigramas, ... Incluidos los códigos binarios incluidos en los comentarios. | todos los comentarios codificados |
Documentos naturales | ||||
NDoc | ||||
perldoc | Amplíe las clases del generador a través de la programación Perl. | Solo enlazando | ||
pdoc | plantillas Jinja2 reemplazables | resaltado de sintaxis de código fuente, enlace cruzado automático a declaraciones de símbolos | sí | |
pdoc3 | plantillas mako reemplazables | resaltado de sintaxis de código fuente, enlace cruzado automático a declaraciones de símbolos | sí | |
phpDocumentor | Plantillas basadas en Smarty (1.x), plantillas basadas en Twig (2+) | diagramas de herencia de clases | referencia cruzada a la documentación generada y a la referencia de la función php.net | sí |
Pydoc | ||||
RDoc | ||||
ROBODoc | ||||
Esfinge | 10 temas; Plantillas Jinja2; Complementos de Python | varios en sphinx-contrib, por ejemplo, usando aafigure, actdiag, Google Chart o gnuplot | Tabla de contenido, índice; referencias cruzadas; resaltado de sintaxis con pigmentos | objetos personalizados (como funciones y clases) |
Experto visual | contenido de documentación y estilos personalizables | Herencia de clases, árboles de llamadas, dependencias (análisis de impacto) | enlaces internos entre clases, métodos, variables, tablas, columnas ... | todos los tipos extraídos |
VSdocman | personalización completa para todos los formatos de salida, plantillas para salida similar a MSDN, etiquetas de comentarios XML personalizadas | diagramas de clases gráficos vinculados, árbol de herencia de clases | enlaces internos y enlaces a la documentación del marco .NET | tipos extraídos y vinculados |
YARDA | plantillas de Ruby personalizables | diagramas de clases con herramienta adicional | clases / módulos internos con referencias cruzadas y fuente Ruby resaltada |
Posibles omisiones
- AsciiDoc
- MkDocs
- RoboHelp
- Roxygen2
- Hugo_ (software)
Ver también
- Legibilidad del código
- Generador de documentación
- Programación alfabetizada
- Código autodocumentado
Notas
- ^ a b c d e f Ddoc tiene un sistema de macros que se puede personalizar para generar cualquier formato deseado. Se probaron CHM, groff (páginas de manual), XHTML, XML y LaTeX (es decir, PostScript y PDF). Actualmente no están incluidos en la distribución estándar. La salida HTML estándar también se genera mediante macros y se puede redefinir.
- ^ a b Generado solo a partir de la salida LaTeX. [3]
- ^ a b c d Aunque no se admite oficialmente como formato de salida, Epydoc utiliza LaTeX y PostScript como pasos intermedios para producir la documentación PDF final.
- ^ a b c d e f g h A través de Doclets de terceros.
- ^ Generado solo a partir de Markdown o salida HTML.
- ^ a b RDoc actualmente solo proporciona generadores para documentos CHM y XML en la versión RDoc proporcionada como parte de Ruby 1.9 Core.
- ^ RDoc genera documentación para RI , que es la versión de Ruby de las páginas de manual de Unix.
- ^ Generado solo a partir de la salida LaTeX
Referencias
- ^ http://zesty.ca/cv.html
- ^ https://www.python.org/dev/peps/pep-0256/
- ^ http://www.stack.nl/~dimitri/doxygen/manual/output.html