Альфапедия

Сравнение генераторов документации

редактировать

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

Содержание

  • 1 Общая информация
  • 2 Поддерживаемые форматы
  • 3 Другие особенности
  • 4 Возможные пропуски
  • 5 См. Также
  • 6 Примечания
  • 7 Ссылки

Общая информация

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

ИмяСоздательФормат вводаЯзыкиПоддержка ОСДата первого общедоступного выпускаПоследняя стабильная версияЛицензия на программное обеспечение
Бруно Пачеко Лопес да СилваТекстCOBOLЛюбой01.08.20201.0.11GPL
Ddoc Уолтер Брайт ТекстDWindows, OS X, Linux и BSD2005/09/19DMD 2.078.3Boost
Документ! X InnovasysТекст, двоичныйТолько C ++ / CLI, Java, C #, VB, VBScript, IDL, PL / SQLТолько Windows19982014.1Собственный
Doxygen Димитри ван Хиш ТекстC / C ++, Java, C #, D, IDL, Fortran, PHP, Python, TclЛюбой1997/10/261.8.20GPL
Epydoc Эдвард ЛоперТекстPythonЛюбой2002/01 / -3.0 (2008)MIT
fpdoc (Free Pascal Documentation Generator)Себастьян ГюнтерТекстПаскаль2005?2.6.4GPL
Haddock Саймон Марлоу ТекстHaskellAny20022.15.0 (2014)BSD
HeaderDoc Apple 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 4D Imagix Corp.TextC, C ++, JavaWindows, Linux, Unix19957.3Собственный
Javadoc Sun Microsystems ТекстJavaЛюбой19951.6GPL
LAMP, EPFLТекстScalaЛюбой20111.0Лицензия Scala
JSDoc Майкл МэтьюзТекстJavaScriptЛюбой2001/07 / -1.10.2GPL
JsDoc Toolkit Майкл МэтьюзТекстJavaScriptЛюбые2007?2.0.0MIT
mkd Jean-Paul LouyotТекстЛюбые с комментариямиЛюбые ()19892015EUPL GPL
Natural Docs Грег ВалюрТекстЛюбой с комментариямиЛюбой26.05.20032.0.2GPL
NDoc Джейсон Даймонд, Жан-Клод Маноли, Краль FerchДвоичныйC #Только для Windows27.07.20031.3.1GPL
Pandoc Джон Макфарлейн??Любой20061.14.0.3 (2015)GPL
pdoc3 kerncТекстPythonЛюбой20130.9.1 (2020)Affero GPL
perldoc Ларри Уолл ТекстPerlЛюбой19945.16.3Художественный, GPL
phpDocumentor Джошуа ЭйхорнТекстPHPЛюбой20003.0.0LGPL для 1.x, MIT для 2+
pydoc Ka-Ping YeeТекстPythonЛюбой2000в ядре PythonPython
RDoc Дэйв ТомасТекстC, C ++, RubyЛюбой2001/12/14в ядре RubyRuby
ROBODoc Frans SlothouberТекстЛюбые с комментариямиЛюбые1995/01/194.99.36 (2015)GPL
Sandcastle Microsoft Text.NETТолько для Windows2008/05 / -2014.5.31.0Ms-PL
Sphinx Георг БрандлТекстC, C ++, Ada, Fortran, PHP, Python, Ruby, JavaScriptЛюбой21/03/20081.6.3BSD
Visual Expert NovalysТекст, двоичныйC #, PL / SQL, Transact-SQL, PowerBuilderТолько для Windows19952017Собственный
VSdocman HelixoftТекстC #, VB, VBScriptТолько для Windows2 октября 2003 г.9.0Собственный
ДВОР Лорен СигалТекстРубиЛюбой24.02.20070.7.3MIT
ИмяСоздательInp формат utЯзыкиПоддержка ОСДата первого публичного выпускаПоследняя стабильная версияЛицензия на программное обеспечение

Поддерживаемые форматы

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

HTML CHM RTF PDF LaTeX PostScript справочные страницы DocBook XML ePub
ДаНетНетНетНетНетНетНетНет
Ddoc ДаДаНетДаДаДаДаНетДа
Документ! X ДаДаНетНетНетНетНетНетНет
Doxygen ДаДаДаНепосредственноДаНепосредственноДаДаДаНет
Epydoc ДаНетНетДаНепосредственноНепосредственноНетНетНет
Пикша ДаДаНетНетНетНетНетЧастичноНет
HeaderDoc ДаНетНетНетНетНетДаНетДа
Imagix 4D ДаНетДаНетНетНетНетНетНет
Javadoc ДаКосвенноКосвенноКосвенноКосвенноКосвенноКосвенноКосвенноКосвенно
JSDoc ДаНетНетНетНетНетНетНетНет
JsDoc Toolkit ДаНетНетНетНетНетНетНетДа + JSON
Natural Docs ДаНетНетНетНетНетНетНетНет
NDoc ДаДаНетНетНетНетНетНетНет
pdoc3 ДаНетНетКосвенноНетНетНетНетНетНет
phpDocumentor ДаДа (только 1.x)НетДа (только 1.x)НетНетНетДа (только 1.x)Да (только 1.x)
pydoc ДаНетНетНетНетНетНетНетНетНет
RDoc ДаДаНетНетНетНетКосвенноНетДа
ROBODoc ДаКосвенноДаКосвенноДаКосвенноДаДаНет
Сэндкасл ДаДаНетНетНетНетНетНетНет
Сфинкс ДаДаНепосредственноДаДаДа
Визуальный эксперт ДаНетНетНетНетНетНетНетНет
VSdocman ДаДаНетДаНетНетНетНетДа
ДВОР ДаНетНетНетНетНетНетНетНет
HTMLCHMRTFPDFLaTeXPostScriptстраницы руководстваDocBookXMLePub

Другие функции

возможность расширенной настройкисгенерировано диаграммывыделение и связывание сгенерированных docтипов параметров, извлеченных
Да
Ddoc с макросами
Document! X настраиваемые шаблоны на основе HTML, настраиваемые теги комментариевсхемы взаимосвязей связанных графических объектоввнутренние ссылки и ссылки на документацию.NET frameworkтипы извлеченных и связанных
Doxygen с XSLTграфами вызывающего и вызываемого, графами зависимостей, диаграммами наследования, диаграммами сотрудничества
Epydoc
Haddock ДаДа
HeaderDoc Пользовательские верхние и нижние колонтитулы, цвет кода и другие стили CSS на отдельных страницах. Оглавление проекта создается на основе пользовательского шаблона.Настраиваемая подсветка / раскраска синтаксиса с автоматической привязкой к символам в объявлении, возможность вручную ссылаться на символы в обсуждении и т. Д.Предоставляет предупреждения, если помеченные параметры не соответствуют коду, проанализированные параметры включены в вывод XML и Файл тегов в стиле Doxygen (флаг -D в 8.7). Частичная поддержка препроцессора C с флагом -p. Поддержка # if / # ifdef для управления включением документации с помощью флагов командной строки -D и -U.
Imagix 4D настраивается с помощью таблиц стилей и CSSсвязанных иерархий и графиков зависимостей для вызовов функций, наборов переменных и чтения, наследования классов и интерфейса, а также файлов и интерфейсов, внутрифункциональных блок-схемполностью перекрестно связанные в рамках проекта, включая все иерархии и графики зависимостей, таблицы показателей, фрагменты исходного кода и исходные файлыполный семантический анализ исходного кода, включая типы параметров, условную компиляцию директивы, расширения макросов
Javadoc
JSDoc Да
JsDoc Toolkit Да
mkd Настраиваемый для всех типов комментариев«как есть» в комментариико всей общей документации; ссылки, руководство, органиграммы,... Включая двоичные коды, включенные в комментарии.все закодированные комментарии
Natural Docs
NDoc
perldoc Расширьте классы генератора с помощью программирования на Perl.Только связывание
pdoc3 замещаемых шаблонов makoподсветка синтаксиса исходного кода, автоматическая перекрестная ссылка на объявления символовДа
phpDocumentor Шаблоны на основе Smarty (1.x), шаблоны на основе Twig (2+)диаграммы наследования классовперекрестные ссылки на сгенерированную документацию и ссылку на функцию php.netДа
pydoc
RDoc
ROBODoc
Sphinx 10 тем; Шаблоны Jinja2; Плагины Pythonнесколько в sphinx-contrib, например с помощью aafigure, actdiag, Google Chart или gnuplotTable of Contents, Index; перекрестные ссылки; подсветка синтаксиса с помощью Pygmentsнастраиваемых объектов (таких как функции и классы)
Visual Expert содержимое документации и настраиваемые стилиНаследование классов, деревья вызовов, зависимости (анализ воздействия)внутренние связи между классами, методами, переменными, таблицами, столбцами...все типы извлечены
VSdocman полная настройка для всех форматов вывода, шаблоны для вывода в стиле MSDN, пользовательские теги комментариев XMLсвязанные графические диаграммы классов, дерево наследования классоввнутренние ссылки и ссылки на документацию.NET frameworkизвлеченные и связанные типы
YARD настраиваемые шаблоны Rubyдиаграммы классов с дополнительным инструментомперекрестные ссылки на внутренние классы / модули и выделение исходного кода Ruby

Возможные упущения

См. Также

Примечания

Ссылки

Последняя правка сделана 2021-05-15 08:03:19
Содержание доступно по лицензии CC BY-SA 3.0 (если не указано иное).
Обратная связь: support@alphapedia.ru
Соглашение
О проекте