Из Википедии, бесплатной энциклопедии
Перейти к навигации Перейти к поиску

В следующих таблицах сравнивается общая и техническая информация для ряда генераторов документации . Пожалуйста, смотрите статьи по отдельным продуктам для получения дополнительной информации. Если иное не указано в сносках, сравнения основаны на стабильных версиях без каких-либо надстроек, расширений или внешних программ. Обратите внимание, что многие из перечисленных генераторов больше не обслуживаются.

Общая информация [ править ]

Основная общая информация о генераторах, в том числе: создатель или компания, лицензия и цена.

ИмяСоздательФормат вводаЯзыкиПоддержка ОСДата первого публичного выпускаПоследняя стабильная версияЛицензия на программное обеспечение
COBOLDocБруно Пачеко Лопеш да СилваТекстКОБОЛЛюбой2020/08/011.0.11GPL
DdocУолтер БрайтТекстDWindows, OS X, Linux и BSD2005/09/19DMD 2.078.3Увеличение
Документ! ИксInnovasysТекст, двоичныйТолько C ++ / CLI, Java, C #, VB, VBScript, IDL, PL / SQLТолько Windows1998 г.2014.1Проприетарный
DoxygenДимитри ван ХеешТекстC / C ++, Java, C #, D, IDL, Фортран, PHP, PythonЛюбой1997/10/261.9.1GPL
ЭпидокЭдвард ЛоперТекстPythonЛюбой2002/01 / -3,0 (2008)Массачусетский технологический институт
fpdoc (генератор документации Free Pascal)Себастьян ГюнтерТекстПаскаль[ требуется проверка ]2005?2.6.4GPL
ПикшаСаймон МарлоуТекстHaskellЛюбой2002 г.2.15.0 (2014)BSD
HeaderDocApple Inc.ТекстC, C ++, Java, Delphi, Pascal, IDL, PHP, Perl, Python, Ruby, JavaScript, Tcl, AppleScript, MIG, Bash, CshЛюбой Unix-подобный2000/09 / -8.9.28 (2013)APSL
Imagix 4DImagix Corp.ТекстC, C ++, JavaWindows, Linux, Unix1995 г.7.3Проприетарный
JavadocSun MicrosystemsТекстЯваЛюбой1995 г.1.6GPL
ScalaDocЛАМПА, EPFLТекстScalaЛюбой2011 г.1.0Лицензия Scala
JSDocМайкл МэтьюзТекстJavaScriptЛюбой2001/07 / -1.10.2GPL
Набор инструментов JsDocМайкл МэтьюзТекстJavaScriptЛюбой2007?2.0.0Массачусетский технологический институт
мкдЖан-Поль ЛуайоТекстЛюбой с комментариямиЛюбые ( [ OS X? Требуется проверка ] )1989 г.2015 г.EUPL GPL
Естественные документыГрег ВалюрТекстЛюбой с комментариямиЛюбой26.05.20032.0.2GPL
NDocДжейсон Даймонд, Жан-Клод Маноли, Краль ФерчДвоичныйC #Только Windows27.07.20031.3.1GPL
Pandoc [ требуется проверка ]Джон Макфарлейн??Любой2006 г.1.14.0.3 (2015)GPL
pdocЭндрю ГаллантТекстPythonЛюбой20131.0.1 (2021 год)Безлицензия
pdoc3KerncТекстPythonЛюбой2018 г.0.9.2 (2020)Афферо GPL
PerldocЛарри УоллТекстPerlЛюбой1994 г.5.16.3Художественный , GPL
phpDocumentorДжошуа ЭйхорнТекстPHPЛюбой2000 г.3.0.0LGPL для 1.x, MIT для 2+
PydocКа-Пинг Йи [1] [2]ТекстPythonЛюбой2000 г.в ядре PythonPython
RDocДэйв ТомасТекстC, C ++, RubyЛюбой2001/12/14в ядре RubyРубин
ROBODocFrans SlothouberТекстЛюбой с комментариямиЛюбой1995.01.194.99.36 (2015)GPL
замок из пескаMicrosoftТекст.СЕТЬТолько Windows2008/05 / -2014.5.31.0Ms-PL
СфинксГеорг БрандлТекстC, C ++, Ada, Fortran, PHP, Python, Ruby, JavaScript.Любой2008/03/213.5.4BSD
Визуальный экспертНовалисТекст, двоичныйC #, PL / SQL, Transact-SQL, PowerBuilderТолько Windows1995 г.2017 г.Проприетарный
VSdocmanHelixoftТекстC #, VB, VBScriptТолько Windows2 октября 2003 г.9.0Проприетарный
ПЛОЩАДКАЛорен СигалТекстРубинЛюбой2007/02/240.7.3Массачусетский технологический институт
ИмяСоздательФормат вводаЯзыкиПоддержка ОСДата первого публичного выпускаПоследняя стабильная версияЛицензия на программное обеспечение

Поддерживаемые форматы [ править ]

Форматы вывода, которые могут записывать генераторы.

HTMLCHMRTFPDFЛатексPostScriptстраницы руководстваDocBookXMLePub
COBOLDocдаНетНетНетНетНетНетНетНет
DdocдаДа [а]НетДа [а]Да [а]Да [а]Да [а]НетДа [а]
Документ! ИксдадаНетНетНетНетНетНетНет
DoxygenдададаКосвенно [b]даКосвенно [b]дададаНет
ЭпидокдаНетНетдаКосвенно [c]Косвенно [c]НетНетНет
ПикшададаНетНетНетНетНетЧастичноеНет
HeaderDocдаНетНетНетНетНетдаНетда
Imagix 4DдаНетдаНетНетНетНетНетНет
JavadocдаКосвенно [d]Косвенно [d]Косвенно [d]Косвенно [d]Косвенно [d]Косвенно [d]Косвенно [d]Косвенно [d]
JSDocдаНетНетНетНетНетНетНетНет
Набор инструментов JsDocдаНетНетНетНетНетНетНетДа + JSON
Естественные документыдаНетНетНетНетНетНетНетНет
NDocдадаНетНетНетНетНетНетНет
pdocдаНетНетНетНетНетНетНетНетНет
pdoc3даНетНетКосвенно [e]НетНетНетНетНетНет
phpDocumentorдаДа (только 1.x)НетДа (только 1.x)НетНетНетДа (только 1.x)Да (только 1.x)
PydocдаНетНетНетНетНетНетНетНетНет
RDocдаДа [f]НетНетНетНетКосвенно [г]НетДа [f]
ROBODocдаКосвеннодаКосвенно [c]даКосвенно [c]дадаНет
замок из пескададаНетНетНетНетНетНетНет
СфинксдадаКосвенно [ч]дадада
Визуальный экспертдаНетНетНетНетНетНетНетНет
VSdocmanдадаНетдаНетНетНетНетда
ПЛОЩАДКАдаНетНетНетНетНетНетНетНет
HTMLCHMRTFPDFЛатексPostScriptстраницы руководстваDocBookXMLePub

Другие особенности [ править ]

возможность расширенной настройкисгенерированные диаграммывыделение и привязка сгенерированного документатипы параметров извлечены
COBOLDocда
Ddocс макросами
Документ! Икснастраиваемые шаблоны на основе HTML, настраиваемые теги комментариевсхемы взаимосвязей связанных графических объектоввнутренние ссылки и ссылки на документацию по .NET frameworkтипы извлечены и связаны
Doxygenс XSLTграфики вызывающих и вызываемых абонентов, графики зависимостей, диаграммы наследования, диаграммы сотрудничества
Эпидок
Пикшадада
HeaderDocПользовательские верхние и нижние колонтитулы, цвет кода и другие стили CSS на отдельных страницах. Оглавление проекта создается на основе пользовательского шаблона.Настраиваемая подсветка / раскраска синтаксиса с автоматической привязкой к символам в объявлении, возможность вручную ссылаться на символы в обсуждении и т. Д.Предоставляет предупреждения, если тегированные параметры не соответствуют коду, проанализированные параметры включены в вывод XML и файл тегов в стиле Doxygen (флаг -D в 8.7). Частичная поддержка препроцессора C с флагом -p. Поддержка # if / # ifdef для управления включением документации с помощью флагов командной строки -D и -U.
Imagix 4Dнастраивается с помощью таблиц стилей и CSSсвязанные иерархии и графики зависимостей для вызовов функций, наборов переменных и чтения, наследования классов и интерфейса, а также файлов и интерфейсов, внутрифункциональные блок-схемыполностью перекрестно связанные в рамках проекта, включая все иерархии и графики зависимостей, таблицы показателей, фрагменты исходного кода и исходные файлыполный семантический анализ исходного кода, включая типы параметров, директивы условной компиляции, расширения макросов
Javadoc
JSDocда
Набор инструментов JsDocда
мкдНастраивается для всех типов комментариев"как есть" в комментарияхвся общая документация; ссылки, руководство, органиграммы, ... Включая двоичные коды, включенные в комментарии.все закодированные комментарии
Естественные документы
NDoc
PerldocРасширьте классы генератора с помощью программирования на Perl.Только ссылка
pdocзаменяемые шаблоны Jinja2подсветка синтаксиса исходного кода, автоматическая перекрестная ссылка на объявления символовда
pdoc3замещаемые шаблоны макоподсветка синтаксиса исходного кода, автоматическая перекрестная ссылка на объявления символовда
phpDocumentorШаблоны на основе Smarty (1.x), шаблоны на основе Twig (2+)диаграммы наследования классовперекрестная ссылка на сгенерированную документацию и ссылку на функцию php.netда
Pydoc
RDoc
ROBODoc
Сфинкс10 тем оформления; Шаблоны Jinja2; Плагины Pythonнесколько в sphinx-contrib, например, с помощью aafigure, actdiag, Google Chart или gnuplotСодержание, указатель; перекрестные ссылки; подсветка синтаксиса с помощью Pygmentsнастраиваемые объекты (например, функции и классы)
Визуальный экспертсодержание документации и настраиваемые стилиНаследование классов, деревья вызовов, зависимости (анализ влияния)внутренние связи между классами, методами, переменными, таблицами, столбцами ...все типы извлечены
VSdocmanполная настройка для всех форматов вывода, шаблоны для вывода в стиле MSDN, настраиваемые теги комментариев XMLсвязанные графические диаграммы классов, дерево наследования классоввнутренние ссылки и ссылки на документацию по .NET frameworkтипы извлечены и связаны
ПЛОЩАДКАнастраиваемые шаблоны Rubyдиаграммы классов с дополнительным инструментомперекрестные ссылки на внутренние классы / модули и выделенный исходный код Ruby

Возможные упущения [ править ]

  • AsciiDoc
  • MkDocs
  • РобоПомощь
  • Roxygen2
  • Hugo_ (программное обеспечение)

См. Также [ править ]

  • Читаемость кода
  • Генератор документации
  • Грамотное программирование
  • Самодокументирующийся код

Заметки [ править ]

  1. ^ a b c d e f Ddoc имеет систему макросов, которую можно настроить для вывода любого желаемого формата. Были протестированы CHM, groff (страницы руководства), XHTML, XML и LaTeX (например, PostScript и PDF). В настоящее время они не входят в стандартную поставку. Стандартный вывод HTML также создается с использованием макросов и может быть переопределен.
  2. ^ a b Генерируется только из вывода LaTeX. [3]
  3. ^ a b c d Хотя официально не поддерживается в качестве формата вывода, Epydoc использует LaTeX и PostScript в качестве промежуточных шагов для создания окончательной документации в формате PDF.
  4. ^ a b c d e f g h Через документы третьих лиц.
  5. ^ Генерируется только из вывода Markdown или HTML.
  6. ^ a b В настоящее время RDoc предоставляет генераторы для документов CHM и XML только в версии RDoc, предоставляемой как часть ядра Ruby 1.9.
  7. ^ RDoc генерирует документацию для RI , которая является версиейсправочныхстраниц Unix для Ruby.
  8. ^ Генерируется только из вывода LaTeX

Ссылки [ править ]

  1. ^ http://zesty.ca/cv.html
  2. ^ https://www.python.org/dev/peps/pep-0256/
  3. ^ http://www.stack.nl/~dimitri/doxygen/manual/output.html