Porovnání generátorů dokumentace - Comparison of documentation generators
Následující tabulky porovnávají obecné a technické informace pro řadu generátory dokumentace. Další informace najdete v článcích jednotlivých produktů. Není-li v poznámkách pod čarou uvedeno jinak, jsou srovnání založena na stabilních verzích bez doplňků, rozšíření nebo externích programů. Mnoho uvedených generátorů již není udržováno.
Obecná informace
Základní obecné informace o generátorech, včetně: tvůrce nebo společnosti, licence a ceny.
| název | Tvůrce | Vstupní formát | Jazyky | Podpora OS | Datum prvního veřejného vydání | Nejnovější stabilní verze | Softwarová licence |
|---|---|---|---|---|---|---|---|
| COBOLDoc | Bruno Pacheco Lopes da Silva | Text | COBOL | Žádný | 2020/08/01 | 1.0.11 | GPL |
| Ddoc | Walter Bright | Text | D | Windows, OS X, Linux a BSD | 2005/09/19 | DMD 2,078,3 | Zvýšit |
| Dokument! X | Innovasys | Text, binární | Pouze C ++ / CLI, Java, C #, VB, VBScript, IDL, PL / SQL | Pouze Windows | 1998 | 2014.1 | Proprietární |
| Doxygen | Dimitri van Heesch | Text | C / C ++, Java, C #, D, IDL, Fortran, PHP, Python, Tcl | Žádný | 1997/10/26 | 1.8.20 | GPL |
| Epydoc | Edward Loper | Text | Krajta | Žádný | 2002/01/— | 3.0 (2008) | MIT |
| fpdoc (Generátor dokumentace Free Pascal) | Sebastian Guenther | Text | Pascal | [je nutné ověření ] | 2005? | 2.6.4 | GPL |
| Treska jednoskvrnná | Simon Marlow | Text | Haskell | Žádný | 2002 | 2.15.0 (2014) | BSD |
| Záhlaví | Apple Inc. | Text | C, C ++, Java, Delphi, Pascal, IDL, PHP, Perl, Python, Ruby, JavaScript, Tcl, AppleScript, MIG, Bash, Csh | Jakékoli Unixové | 2000/09/— | 8.9.28 (2013) | APSL |
| Imagix 4D | Imagix Corp. | Text | C, C ++, Java | Windows, Linux, Unix | 1995 | 7.3 | Proprietární |
| Javadoc | Sun Microsystems | Text | Jáva | Žádný | 1995 | 1.6 | GPL |
| ScalaDoc | SVĚTLO, EPFL | Text | Scala | Žádný | 2011 | 1.0 | Licence Scala |
| JSDoc | Michael Mathews | Text | JavaScript | Žádný | 2001/07/— | 1.10.2 | GPL |
| Sada nástrojů JsDoc | Michael Mathews | Text | JavaScript | Žádný | 2007? | 2.0.0 | MIT |
| mkd | Jean-Paul Louyot | Text | Jakékoli s komentáři | Jakékoli ([OS X? je nutné ověření ]) | 1989 | 2015 | EUPL GPL |
| Přírodní dokumenty | Greg Valure | Text | Jakékoli s komentáři | Žádný | 2003/05/26 | 2.0.2 | GPL |
| NDoc | Jason Diamond, Jean-Claude Manoli, Kral Ferch | Binární | C# | Pouze Windows | 2003/07/27 | 1.3.1 | GPL |
| Pandoc[je nutné ověření ] | John MacFarlane | ? | ? | Žádný | 2006 | 1.14.0.3 (2015) | GPL |
| pdoc3[1] | kernc | Text | Krajta | Žádný | 2013 | 0.9.1 (2020) | Affero GPL |
| perldoc | Larry Wall | Text | Perl | Žádný | 1994 | 5.16.3 | Umělecký, GPL |
| phpDocumentor | Joshua Eichorn | Text | PHP | Žádný | 2000 | 3.0.0 | LGPL pro 1.x, MIT pro 2+ |
| pydoc | Ka-Ping Yee[2][3] | Text | Krajta | Žádný | 2000 | v jádru Pythonu | Krajta |
| RDoc | Dave Thomas | Text | C, C ++, Ruby | Žádný | 2001/12/14 | v jádru Ruby | Rubín |
| ROBODoc | Frans Slothouber | Text | Jakékoli s komentáři | Žádný | 1995/01/19 | 4.99.36 (2015) | GPL |
| hrad z písku | Microsoft | Text | .SÍŤ | Pouze Windows | 2008/05/— | 2014.5.31.0 | Ms-PL |
| Sfinga | Georg Brandl | Text | C, C ++, Ada, Fortran, PHP, Python, Ruby, JavaScript | Žádný | 2008/03/21 | 1.6.3 | BSD |
| Vizuální expert | Novalys | Text, binární | C #, PL / SQL, Transact-SQL, PowerBuilder | Pouze Windows | 1995 | 2017 | Proprietární |
| VSdocman | Helixoft | Text | C #, VB, VBScript | Pouze Windows | 2003 2. října | 9.0 | Proprietární |
| YARD | Loren Segal | Text | Rubín | Žádný | 2007/02/24 | 0.7.3 | MIT |
| název | Tvůrce | Vstupní formát | Jazyky | Podpora OS | Datum prvního veřejného vydání | Nejnovější stabilní verze | Softwarová licence |
Podporované formáty
Výstupní formáty, které mohou generátory zapisovat.
| HTML | CHM | RTF | Latex | PostScript | manuálové stránky | DocBook | XML | ePub | ||
|---|---|---|---|---|---|---|---|---|---|---|
| COBOLDoc | Ano | Ne | Ne | Ne | Ne | Ne | Ne | Ne | Ne | |
| Ddoc | Ano | Ano[A] | Ne | Ano[A] | Ano[A] | Ano[A] | Ano[A] | Ne | Ano[A] | |
| Dokument! X | Ano | Ano | Ne | Ne | Ne | Ne | Ne | Ne | Ne | |
| Doxygen | Ano | Ano | Ano | Nepřímo[b] | Ano | Nepřímo[b] | Ano | Ano | Ano | Ne |
| Epydoc | Ano | Ne | Ne | Ano | Nepřímo[C] | Nepřímo[C] | Ne | Ne | Ne | |
| Treska jednoskvrnná | Ano | Ano | Ne | Ne | Ne | Ne | Ne | Částečný | Ne | |
| Záhlaví | Ano | Ne | Ne | Ne | Ne | Ne | Ano | Ne | Ano | |
| Imagix 4D | Ano | Ne | Ano | Ne | Ne | Ne | Ne | Ne | Ne | |
| Javadoc | Ano | Nepřímo[d] | Nepřímo[d] | Nepřímo[d] | Nepřímo[d] | Nepřímo[d] | Nepřímo[d] | Nepřímo[d] | Nepřímo[d] | |
| JSDoc | Ano | Ne | Ne | Ne | Ne | Ne | Ne | Ne | Ne | |
| Sada nástrojů JsDoc | Ano | Ne | Ne | Ne | Ne | Ne | Ne | Ne | Ano + JSON | |
| Přírodní dokumenty | Ano | Ne | Ne | Ne | Ne | Ne | Ne | Ne | Ne | |
| NDoc | Ano | Ano | Ne | Ne | Ne | Ne | Ne | Ne | Ne | |
| pdoc3 | Ano | Ne | Ne | Nepřímo[E] | Ne | Ne | Ne | Ne | Ne | Ne |
| phpDocumentor | Ano | Ano (pouze 1.x) | Ne | Ano (pouze 1.x) | Ne | Ne | Ne | Ano (pouze 1.x) | Ano (pouze 1.x) | |
| pydoc | Ano | Ne | Ne | Ne | Ne | Ne | Ne | Ne | Ne | Ne |
| RDoc | Ano | Ano[F] | Ne | Ne | Ne | Ne | Nepřímo[G] | Ne | Ano[F] | |
| ROBODoc | Ano | Nepřímo | Ano | Nepřímo[C] | Ano | Nepřímo[C] | Ano | Ano | Ne | |
| hrad z písku | Ano | Ano | Ne | Ne | Ne | Ne | Ne | Ne | Ne | |
| Sfinga | Ano | Ano | Nepřímo[h] | Ano | Ano | Ano | ||||
| Vizuální expert | Ano | Ne | Ne | Ne | Ne | Ne | Ne | Ne | Ne | |
| VSdocman | Ano | Ano | Ne | Ano | Ne | Ne | Ne | Ne | Ano | |
| YARD | Ano | Ne | Ne | Ne | Ne | Ne | Ne | Ne | Ne | |
| HTML | CHM | RTF | Latex | PostScript | manuálové stránky | DocBook | XML | ePub |
Další funkce
| možnost rozšířeného přizpůsobení | generované diagramy | zvýraznění a propojení vygenerovaného doc | extrahované typy parametrů | |
|---|---|---|---|---|
| COBOLDoc | Ano | |||
| Ddoc | s makry | |||
| Dokument! X | přizpůsobitelné šablony založené na HTML, vlastní značky komentářů | propojené grafické vztahy diagramy objektů | interní odkazy a odkazy na dokumentaci .NET framework | typy extrahované a propojené |
| Doxygen | s XSLT | grafy volajících a volaných, grafy závislostí, diagramy dědičnosti, diagramy spolupráce | ||
| Epydoc | ||||
| Treska jednoskvrnná | Ano | Ano | ||
| Záhlaví | Vlastní záhlaví, zápatí, zbarvení kódu a další styly CSS na jednotlivých stránkách. TOC pro celý projekt je generován z uživatelem definované šablony. | Konfigurovatelné zvýraznění / vybarvení syntaxe s automatickým propojením se symboly v deklaraci, možnost ručního propojení se symboly v diskusi atd. | Poskytuje varování, pokud tagované parametry neodpovídají kódu, analyzované parametry obsažené ve výstupu XML a tagfile ve stylu Doxygen (příznak -D v 8.7). Částečná podpora preprocesoru C s příznakem -p. Podpora kontroly # if / # ifdef nad zahrnutím dokumentace pomocí příznaků příkazového řádku -D a -U. | |
| Imagix 4D | přizpůsobitelné pomocí stylů a CSS | propojené hierarchické a závislostní grafy pro volání funkcí, sady proměnných a čtení, dědičnost a rozhraní tříd a soubor zahrnuje a rozhraní, vývojové diagramy uvnitř funkce | plně propojený v rámci celého projektu, včetně všech grafů hierarchie a závislostí, tabulek metrik, fragmentů zdrojového kódu a zdrojových souborů | úplná sémantická analýza zdrojového kódu, včetně typů parametrů, směrnic podmíněné kompilace, rozšíření makra |
| Javadoc | ||||
| JSDoc | Ano | |||
| Sada nástrojů JsDoc | Ano | |||
| mkd | Přizpůsobitelné pro všechny typy komentářů | „jak je“ v komentářích | veškerá obecná dokumentace; reference, manuál, organigramy, ... Včetně binárních kódů obsažených v komentářích. | všechny kódované komentáře |
| Přírodní dokumenty | ||||
| NDoc | ||||
| perldoc | Rozšiřte třídy generátoru pomocí programování v Perlu. | Pouze propojení | ||
| pdoc3 | přepsatelné šablony mako | zvýraznění syntaxe zdrojového kódu, automatické křížové propojení s deklaracemi symbolů | Ano | |
| phpDocumentor | Šablony založené na Smarty (1.x), šablony založené na větvičce (2+) | třídní diagramy dědičnosti | křížový odkaz na generovanou dokumentaci a na odkaz na funkci php.net | Ano |
| pydoc | ||||
| RDoc | ||||
| ROBODoc | ||||
| Sfinga | 10 témat; Jinja2 šablonování; Pluginy Pythonu | několik v sphinx-contrib, např. pomocí aafigure, actdiag, Google Chart nebo gnuplot | Obsah, rejstřík; křížové odkazy; zvýraznění syntaxe pomocí Pygmentů | vlastní objekty (například funkce a třídy) |
| Vizuální expert | přizpůsobitelný obsah a styly dokumentace | Dědičnost tříd, stromy volání, závislosti (analýza dopadů) | vnitřní vazby mezi třídami, metodami, proměnnými, tabulkami, sloupci ... | všechny typy extrahovány |
| VSdocman | plné přizpůsobení pro všechny výstupní formáty, šablony pro výstup podobný MSDN, vlastní značky komentářů XML | propojené grafické diagramy tříd, strom dědičnosti tříd | interní odkazy a odkazy na dokumentaci .NET framework | typy extrahované a propojené |
| YARD | přizpůsobitelné šablony Ruby | třídní diagramy s dalším nástrojem | interní třídy / moduly s křížovými odkazy a zdrojem Ruby zvýrazněny |
Možná opomenutí
Viz také
Poznámky
- ^ A b C d E F Ddoc má systém maker, který lze přizpůsobit pro výstup libovolného požadovaného formátu. Byly testovány CHM, groff (manpages), XHTML, XML a LaTeX (tedy PostScript a PDF). V současné době nejsou součástí standardní distribuce. Standardní výstup HTML je také generován pomocí maker a lze jej předefinovat.
- ^ A b Generováno pouze z výstupu LaTeXu.[4]
- ^ A b C d Ačkoli není oficiálně podporován jako výstupní formát, používá Epydoc LaTeX a PostScript jako mezikrok k vytvoření finální dokumentace PDF.
- ^ A b C d E F G h Přes Doclety od třetích stran.
- ^ Generováno pouze z výstupu Markdown nebo HTML.
- ^ A b RDoc v současné době poskytuje pouze generátory pro dokumenty CHM a XML ve verzi RDoc poskytované jako součást Ruby 1.9 Core.
- ^ RDoc generuje dokumentaci pro RI, což je Rubyho verze manuálových stránek Unixu.
- ^ Generováno pouze z výstupu LaTeXu