Категории

Doxygen

Doxygen – безплатна междуплатформена система за документиране на изходния код, която поддържа C/C++, Objective-C, Python, Java, IDL, PHP, C#, Fortran, VHDL и отчасти, D.

Doxygen генерира документация от набор от изходен код и може също така да бъде конфигурирана да извлича програмна структура от недокументиран изходен код. Възможно е да се съставят графики на зависимостите на програмните обекти, диаграми на класовете и хипервръзки към изходните кодове.

Doxygen има вградена поддръжка за генериране на документация във формат HTML, LaTeX, man, RTF и XML.. Изходът може също така лесно да се преобразува в CHM, PostScript, PDF.

За представянето на HTML-на документация, разположена на уеб сървъри, има удобен начин за организиране на търсенията (с помощта на модула PHP, създаден от Doxygen’s) и връзките към външна документация.

Doxygen се използва от много проекти, включително KDE Software Compilation, Pidgin, Torque Game Engine, AbiWord, Mozilla, FOX Toolkit, Crystal Space, Drupal. В KDevelop има вградена поддръжка.

Doxygen – конзолна програма в духа на класическия Unix.. Тя работи като компилатор, анализира изходния код и създава документация. Опциите за създаване на документация се четат от конфигурационен файл, който има прост текстов формат.

За да се опрости манипулирането на конфигурационния файл (който съдържа доста настройки), има няколко помощни програми с графичен интерфейс. Една от тях, Doxywizard, се доставя с Doxygen.. Преди това тя е била реализирана с помощта на Qt версия 3 и не е имала много удобен интерфейс. Като алтернатива през лятото на 2008 г. беше пусната алтернативна графична обвивка Doxygate ( http://sourceforge.net/projects/doxygate ), която се основава на Qt версия 4. Но скоро Doxywizard беше пренаписан на Qt версия 4 и проектът Doxygate беше закрит (вж. страницата на проекта на адрес sourceforge.net ).

Категории: Генератори на документация, За разработчици

Реклама