Aby kod był dobrze opisany w wygenerowanej przez Doxygena dokumentacji, należy zastosować w trakcie pisania programu odpowiedni format komentarzy. Wówczas łatwo i bez wysiłku otrzymamy nieźle wyglądający podręcznik opisujący nasz kod.
Doxygen 1.4.2 |
Wymagania: Linux/Windows/Mac OS X, ok. 10 MB na dysku |
dokumentowanie wielu języków, wieloplatformowość, publikowanie wyników w różnych formatach |
Cena: freeware (GNU) www.stack.nl/~dimitri/doxygen/ |
Formaty wyjściowe Doxygena, w których można zapisywać dokumentację, to HTML, skompresowany HTML (wykorzystywany m.in. w Pomocy Windows 98), LaTeX, man pages (format podręcznika do Linuksa, dostępnego po wydaniu komendy man), RTF oraz XML (obsługa tego standardu jest wciąż rozwijana). Ponadto możemy tworzyć dokumentację w postaci plików PostScript i PDF. Samo przygotowywanie dokumentacji jest bajecznie łatwe. Do dyspozycji mamy prosty, jednookienkowy kreator lub bardzo zaawansowany, w którym możemy decydować praktycznie o każdym szczególe tworzonej dokumentacji (linki do struktur, diagramy klas itp.).
Doxygena używają różne zespoły deweloperskie. Wśród nich nie zabrakło nawet znanych projektów, takich jak iTunes COM SDK, gtkmm, KDE, OpenTCP, OGRE, libgocr czy GameBoy Developers Kit (GBDK). Doxygen to bardzo praktyczne narzędzie, na dodatek dostępne zupełnie za darmo. Jego rozbudowana funkcjonalność znacząco przyspieszy tworzenie dokumentacji czy też umożliwi publikowanie źródeł w Internecie w postaci stron WWW, co jest często praktykowane w wypadku projektów Open Source.