Doxygen — различия между версиями
Korogodin (обсуждение | вклад) |
Korogodin (обсуждение | вклад) |
||
| Строка 7: | Строка 7: | ||
Для html-представления документации, размещаемого на web-серверах, существует удобный способ организации поиска (при помощи создаваемого Doxygen'ом PHP-модуля) и ссылок на внешнюю документацию. | Для html-представления документации, размещаемого на web-серверах, существует удобный способ организации поиска (при помощи создаваемого Doxygen'ом PHP-модуля) и ссылок на внешнюю документацию. | ||
| − | Doxygen - консольная программа в духе классической Unix. Она работает подобно компилятору, анализируя исходные тексты и создавая документацию. | + | Doxygen - консольная программа в духе классической Unix. Она работает подобно компилятору, анализируя исходные тексты и создавая документацию. [ Пример.] |
== Doxywizard == | == Doxywizard == | ||
| − | Для упрощения манипуляций с конфигурационным файлом (а он содержит довольно много настроек), существует несколько утилит с графическим интерфейсом. Одна из них, doxywizard, поставляется вместе с Doxygen. | + | Параметры создания документации читаются из конфигурационного файла, имеющего простой текстовый формат. Для упрощения манипуляций с конфигурационным файлом (а он содержит довольно много настроек), существует несколько утилит с графическим интерфейсом. Одна из них, doxywizard, поставляется вместе с Doxygen. |
== Graphiz == | == Graphiz == | ||
| Строка 18: | Строка 18: | ||
== Ссылки == | == Ссылки == | ||
| + | * [http://wiki.scilab.org/Doxygen%20documentation%20Examples Document the code with Doxygen] | ||
* [http://www.devexp.ru/2010/02/ispolzovanie-doxygen-dlya-dokumentirovaniya-koda/ Использование Doxygen для документирования кода] | * [http://www.devexp.ru/2010/02/ispolzovanie-doxygen-dlya-dokumentirovaniya-koda/ Использование Doxygen для документирования кода] | ||
* [http://www.stack.nl/~dimitri/doxygen/index.html Doxygen] | * [http://www.stack.nl/~dimitri/doxygen/index.html Doxygen] | ||
Версия 16: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
Параметры создания документации читаются из конфигурационного файла, имеющего простой текстовый формат. Для упрощения манипуляций с конфигурационным файлом (а он содержит довольно много настроек), существует несколько утилит с графическим интерфейсом. Одна из них, doxywizard, поставляется вместе с Doxygen.
Graphiz
Graphviz – это свободно распространяемый пакет утилит для визуализации данных. Нам он нужен для того, чтобы Doxygen мог показать в документации отношения наследования, графы вызовов и прочую информацию в виде наглядных изображений.
Ссылки
- Document the code with Doxygen
- Использование Doxygen для документирования кода
- Doxygen
- Doxygate
- Документация на русском
