Doxygen: Генерация документации из исходного кода программного обеспечения
Doxygen
Doxygen: бесплатная программа для автоматической генерации документации из исходного кода. Анализ кода, создание диаграмм и перекрестных ссылок. GPLv2.
Сравнивайте с английским: нажмите на абзац — оригинал откроется в окне. Кнопка EN под абзацем показывает его прямо в тексте.
Содержание
Введение
Свободное программное обеспечение для генерации документации по программному обеспечению из исходного кода
Free software for generating software documentation from source code
Doxygen (произносится /ˈdɒksiːdʒən/ DOKsee jən) — это генератор документации и инструмент статического анализа для исходного кода программного обеспечения. В режиме генерации документации Doxygen извлекает информацию из специально оформленных комментариев в коде. В режиме анализа Doxygen использует дерево разбора для создания диаграмм и схем структуры кода. Doxygen позволяет осуществлять перекрестные ссылки между документацией и кодом, что позволяет читателю документации легко обращаться к соответствующему коду. Doxygen является свободным программным обеспечением, распространяемым по лицензии GNU General Public License версии 2 (GPLv2).
Doxygen ('/d//ɒ//k//s//i//dʒ//ən/ DOKsee jən) is a documentation generator and static analysis tool for software source trees. When used as a documentation generator, Doxygen extracts information from specially formatted comments within the code. When used for analysis, Doxygen uses its parse tree to generate diagrams and charts of the code structure. Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code. Doxygen is free software, released under the terms of the GNU General Public License version2 (GPLv2).
Дизайн
Как и Javadoc, Doxygen извлекает документацию из комментариев в исходных файлах. Помимо синтаксиса Javadoc, Doxygen поддерживает теги документации, используемые в инструментарии Qt, и может генерировать вывод в виде гипертекстовой разметки (HTML), а также в форматах Microsoft Compiled HTML Help (CHM), Rich Text Format (RTF), Portable Document Format (PDF), LaTeX, PostScript или man pages.
Like Javadoc, Doxygen extracts documentation from source file comments. In addition to the Javadoc syntax, Doxygen supports the documentation tags used in the Qt toolkit and can generate output in HyperText Markup Language (HTML) as well as in Microsoft Compiled HTML Help (CHM), Rich Text Format (RTF), Portable Document Format (PDF), LaTeX, PostScript or man pages.
Применение
Языки программирования, поддерживаемые Doxygen, включают C, C++, C#, D, Fortran, IDL, Java, Objective C, Perl, PHP, Python и VHDL.
Programming languages supported by Doxygen include C, C++, C#, D, Fortran, IDL, Java, Objective C, Perl, PHP, Python, and VHDL.
Источник и развитие доксигена
Источники Doxygen в настоящее время размещены на GitHub, где основной разработчик, Дмитрий ван Хиш, публикует свои наработки под именем пользователя "doxygen". Doxygen написан на C++ и состоит примерно из 300 000 строк исходного кода. Для лексического анализа используется стандартный инструмент Lex (или его замена Flex), который обрабатывает около 35 000 строк лексических описаний. Инструмент разбора Yacc (или его замена Bison) также применяется, но лишь для вспомогательных задач; основная часть разбора языка реализована на собственном коде C++. Процесс сборки основан на CMake и включает в себя также некоторые скрипты на Python.
The Doxygen sources are currently hosted at GitHub, where the main developer, Dimitri van Heesch, contributes under the user name "doxygen". Doxygen is written in C++, and consists of around 300,000 source lines of code. For lexical analysis, the standard tool Lex (or its replacement Flex) is run via approximately 35,000 lines of lex script. The parsing tool Yacc (or its replacement Bison) is also used, but only for minor tasks; the bulk of language parsing is done by native C++ code. The build process is based on CMake and also involves some Python scripts.