Doxygen - Doxygen

Doxygen
Doxygen.png
Разработчики)Димитри ван Хиш
изначальный выпуск26 октября 1997 г.; 23 года назад (1997-10-26)[1]
Стабильный выпуск
1.8.20[2] / 24 августа 2020; 2 месяца назад (2020-08-24)
Репозиторий
Отредактируйте это в Викиданных
Написано вC ++
Операционная системаКроссплатформенность
ТипГенератор документации
ЛицензияGNU GPLv2
Интернет сайтwww.doxygen.nl

Doxygen (/ˈdɒksяdʒən/ ДОК-смее-чжон )[3] это генератор документации,[4][5][6][7] инструмент для написания справочной документации по программному обеспечению. Документация написана внутри кода, поэтому ее относительно легко поддерживать в актуальном состоянии. Doxygen может перекрестно ссылаться на документацию и код, так что читатель документа может легко ссылаться на реальный код.

Doxygen - это бесплатно программное обеспечение, выпущенный в соответствии с условиями Версия Стандартной общественной лицензии GNU 2 (GPLv2).

Дизайн

подобно Javadoc, Doxygen извлекает документацию из комментариев исходного файла. В дополнение к синтаксису Javadoc Doxygen поддерживает теги документации, используемые в Набор инструментов Qt и может генерировать вывод на языке разметки гипертекста (HTML ) а также в Скомпилированная справка Microsoft HTML (CHM), Расширенный текстовый формат (RTF), Формат переносимого документа (PDF), Латекс, PostScript или страницы руководства.

Использует

Языки программирования поддерживается Doxygen включает C,[8] C ++, C #, D, Фортран, IDL, Ява, Цель-C,[9] Perl,[10] PHP,[11] Python,[12][13] и VHDL.[14] Другие языки могут поддерживаться дополнительным кодом.

Doxygen работает на большинстве Unix-подобный системы, macOS, и Windows.

Первая версия Doxygen заимствовала код из ранней версии DOC ++, разработанной Роландом Вундерлингом и Мальте Цёклером в Институт Цузе Берлин. Позже код Doxygen был переписан Дмитрием ван Хишем.

Doxygen имеет встроенную поддержку для создания диаграмм наследования для классов C ++. Для более сложных диаграмм и графиков Doxygen может использовать инструмент «точка» из Graphviz.[15]

Пример кода

Общий синтаксис комментариев документации заключается в том, чтобы начать комментарий с дополнительной звездочки после ведущего разделителя комментариев '/ *':

/**<A short one line description><Longer description><May span multiple lines or paragraphs as needed>@param Описание входного параметра метода или функции@param ...@return Описание возвращаемого значения*/

Многие программисты любят отмечать начало каждой строки пробелом-звездочкой, как показано ниже, но это не обязательно.

/** * <Краткое однострочное описание> * * <Подробное описание> * <При необходимости может занимать несколько строк или абзацев> * * @param Описание входного параметра метода или функции * @param ... * @return Описание возвращаемого значения */

Многие программисты избегают использования комментариев в стиле C и вместо этого используют однострочные комментарии в стиле C ++. Doxygen принимает комментарии с дополнительной косой чертой как комментарии Doxygen.

/// <Краткое однострочное описание>////// <Подробное описание>/// <Может занимать несколько строк или абзацев по мере необходимости>////// @param Описание входного параметра метода или функции/// @param .../// @return Описание возвращаемого значения

Ниже показано, как C ++ исходный файл может быть задокументирован.

Скриншот того, как результат будет выглядеть в HTML
/** * @файл * @author Джон Доу  * @ версия 1.0 * * @section ЛИЦЕНЗИЯ * * Эта программа является бесплатной; вы можете распространять его и / или * изменить его в соответствии с условиями Стандартной общественной лицензии GNU как * опубликовано Free Software Foundation; либо версия 2 * Лицензия или (по вашему выбору) любая более поздняя версия. * * Эта программа распространяется в надежде, что она будет полезна, но * БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ; даже без подразумеваемой гарантии * КОММЕРЧЕСКАЯ ЦЕННОСТЬ или ПРИГОДНОСТЬ ДЛЯ ОПРЕДЕЛЕННОЙ ЦЕЛИ. См. GNU * Стандартная общественная лицензия для получения более подробной информации на * https://www.gnu.org/copyleft/gpl.html * * @section ОПИСАНИЕ * * Класс времени представляет момент времени. */класс Время {    общественный:       /**        * Конструктор, который устанавливает время на заданное значение.        *        * @param timemillis - количество миллисекунд        * принята с 1 января 1970 г.        */       Время (int Timemillis) {           // код       }       /**        * Получить текущее время.        *        * @return Объект времени, установленный на текущее время.        */       статический Время сейчас же () {           // код       }};

Альтернативный подход к документированию параметров показан ниже. Будет создана такая же документация.

       /**        * Конструктор, который устанавливает время на заданное значение.        */       Время (int Timemillis /// <Количество миллисекунд, прошедших с 1 января 1970 года.>            )       {           // код       }

Также возможна более обширная разметка. Например, добавьте уравнения, используя Латекс команды:

/** * * Встроенное уравнение @ f $ e ^ { pi i} +1 = 0 @ f $ * * Отображаемое уравнение: @f [e ^ { pi i} +1 = 0 @f] * */

Источник и разработка Doxygen

Исходники Doxygen в настоящее время размещены на GitHub, где главный разработчик, Димитри ван Хиш, участвует под именем пользователя doxygen.[16] Doxygen написан на C ++ и насчитывает более 300 000 исходные строки кода. За лексический анализ, стандартный инструмент Лекс (или его замена Flex) выполняется на более чем 35 000 строк сценария lex. В разбор инструмент Yacc (или его замена Bison) тоже используется, но только для второстепенных задач; основная часть синтаксического анализа языка выполняется собственным кодом C ++. В процесс сборки основывается на CMake а также включает в себя некоторые скрипты Python.

Смотрите также

Рекомендации

  1. ^ ОБЪЯВЛЕНИЕ: doxygen 0.1 В архиве 4 октября 2011 г. Wayback Machine, Анонс: первый выпуск Doxygen, системы документации C ++. , Источник: Димитри ван Хиш, Дата: Вс, 26 октября 1997 г., Архив Qt-Interest
  2. ^ http://www.doxygen.nl/manual/changelog.html
  3. ^ FAQ: Как doxygen получил свое название?
  4. ^ Перкель, Джеффри М. (22 ноября 2015 г.). "Get With the Program: Сделай сам, как добавить код в свой арсенал анализа". Ученый (Журнал ). Ученый.
  5. ^ Сабин, Михаэла (22 ноября 2015 г.). «Доксиген». OpenComputing (Вики ). Университет Нью-Гэмпшира. Архивировано из оригинал в 2015-11-23.
  6. ^ «Доксиген». Каталог бесплатных программ (Вики ). 2015-11-22.
  7. ^ "Документация". Код Розетты (Вики ). 2015-11-22.
  8. ^ "Документация: C". Код Розетты (Вики ). 2015-11-22.
  9. ^ «Документация: Objective-C». Код Розетты (Вики ). 2015-11-22.
  10. ^ http://search.cpan.org/perldoc?Doxygen%3A%3AFilter%3A%3APerl
  11. ^ http://www.doxygen.nl/manual/starting.html
  12. ^ «Инструменты автоматического создания документации Python API». python.org вики (Вики ). 2015-11-22.
  13. ^ https://pypi.python.org/pypi/doxypypy/
  14. ^ http://www.doxygen.nl/manual/starting.html
  15. ^ http://www.doxygen.nl/manual/diagrams.html
  16. ^ https://github.com/doxygen/doxygen

внешняя ссылка