Doxygen — различия между версиями
Korogodin (обсуждение | вклад) (Новая страница: «'''Doxygen''' — это кроссплатформенная система документирования исходных текстов, которая под...») |
Korogodin (обсуждение | вклад) |
||
| Строка 10: | Строка 10: | ||
Для упрощения манипуляций с конфигурационным файлом (а он содержит довольно много настроек), существует несколько утилит с графическим интерфейсом. Одна из них, doxywizard, поставляется вместе с Doxygen. | Для упрощения манипуляций с конфигурационным файлом (а он содержит довольно много настроек), существует несколько утилит с графическим интерфейсом. Одна из них, doxywizard, поставляется вместе с Doxygen. | ||
| + | |||
| + | == Ссылки == | ||
| + | * [http://www.stack.nl/~dimitri/doxygen/index.html Doxygen] | ||
| + | * [http://sourceforge.net/projects/doxygate Doxygate] | ||
| + | * [http://www.doxygenorg.ru/ Документация на русском] | ||
| + | |||
| + | == См. также == | ||
| + | * [[Graphviz]] | ||
| + | * [[Doxygate]] | ||
Версия 15:43, 6 апреля 2011
Doxygen — это кроссплатформенная система документирования исходных текстов, которая поддерживает C++, Си, Objective-C, Python, Java, IDL, PHP, C#, Фортран, VHDL и, частично, D.
Doxygen генерирует документацию на основе набора исходных текстов и также может быть настроен для извлечения структуры программы из недокументированных исходных кодов. Возможно составление графов зависимостей программных объектов, диаграмм классов и исходных кодов с гиперссылками.
Doxygen имеет встроенную поддержку генерации документации в формате HTML, LaTeX, man, RTF и XML. Также вывод может быть легко сконвертирован в CHM, PostScript, PDF.
Для html-представления документации, размещаемого на web-серверах, существует удобный способ организации поиска (при помощи создаваемого Doxygen'ом PHP-модуля) и ссылок на внешнюю документацию.
Doxygen - консольная программа в духе классической Unix. Она работает подобно компилятору, анализируя исходные тексты и создавая документацию. Параметры создания документации читаются из конфигурационного файла, имеющего простой текстовый формат.
Для упрощения манипуляций с конфигурационным файлом (а он содержит довольно много настроек), существует несколько утилит с графическим интерфейсом. Одна из них, doxywizard, поставляется вместе с Doxygen.
