Repolode
Предложить
doxygen

doxygen/doxygen

Doxygen генерирует документацию по размеченному исходному коду, а также строит диаграммы структуры и зависимостей даже для кода без комментариев.

Открыть на GitHubСайт
Звёзды
6,596
Форки
1,379
Открытые issues
1,909
Последний коммит
5 дней назад

Что это?

Doxygen извлекает документацию непосредственно из размеченных исходных файлов и создает HTML-браузеры, справочные руководства LaTeX для просмотра офлайн и материалы в других форматах: RTF, PostScript, PDF, DocBook и man-страницы Unix. Поскольку документация хранится рядом с кодом, ее проще поддерживать в соответствии с реализацией.

Doxygen поддерживает C++, C, Objective-C, C#, PHP, Java, Python, IDL, Fortran и в некоторой степени D, а также VHDL. Даже без комментариев он может анализировать исходный код и выявлять его структуру.

Кроме того, Doxygen автоматически строит графы зависимостей подключаемых файлов, диаграммы наследования и взаимодействия классов, помогая разработчикам ориентироваться в больших кодовых базах.

Ключевые возможности

  • 01Генерирует документацию в форматах HTML и LaTeX по размеченному исходному коду
  • 02Поддерживает множество языков, включая C++, C, Java, Python и Fortran
  • 03Экспортирует документацию в RTF, PDF, DocBook и man-страницы Unix
  • 04Автоматически строит диаграммы подключений, наследования и взаимодействия классов
  • 05Извлекает структуру кода из исходников без документации

Сценарии использования

  • Создание справочной документации API для библиотеки на C++
  • Знакомство с большой кодовой базой без документации с помощью сгенерированных графов
  • Создание справочных руководств для проекта, доступных офлайн в формате PDF или LaTeX

Быстрый старт

  1. 1

    Скачайте последние бинарные файлы или исходный код с официального сайта

  2. 2

    Следуйте инструкциям в разделе установки руководства

Что важно знать

  • Распространяется по лицензии GPL-2.0 — лицензии с копилефтом, которая может ограничивать способы распространения производных работ.

Темы

#documentation#code-documentation#api-docs#static-analysis#cpp#code-generation#doxygen#doxygen-documentation

Частые вопросы

Что такое doxygen?
Doxygen генерирует документацию по размеченному исходному коду, а также строит диаграммы структуры и зависимостей даже для кода без комментариев. Doxygen извлекает документацию непосредственно из размеченных исходных файлов и создает HTML-браузеры, справочные руководства LaTeX для просмотра офлайн и материалы в других форматах: RTF, PostScript, PDF, DocBook и man-страницы Unix. Поскольку документация хранится рядом с кодом, ее проще поддерживать в соответствии с реализацией.
doxygen можно использовать бесплатно? Какая у него лицензия?
doxygen распространяется с открытым исходным кодом под лицензией GPL-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.
doxygen всё ещё поддерживается?
Активно поддерживается. Последний коммит в doxygen — 17 окт. 2026 г..
Для чего можно использовать doxygen?
Создание справочной документации API для библиотеки на C++ Знакомство с большой кодовой базой без документации с помощью сгенерированных графов Создание справочных руководств для проекта, доступных офлайн в формате PDF или LaTeX
Как установить doxygen?
Скачайте последние бинарные файлы или исходный код с официального сайта Следуйте инструкциям в разделе установки руководства
Где скачать doxygen?
Исходный код и инструкции по установке — на GitHub: https://github.com/doxygen/doxygen

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты