Doxygen służy do generowania dokumentacji kodu napisanego w C, C++ i Javie. Strona domowa projektu to http://www.doxygen.org. Są do ściągnięcia pakiety RPM na większość popularnych dystrybucji. W nowszych program jest już standardowo obecny.
Jak wszyscy wiemy, nie wszyscy piszą komentarze w kodzie, a później wszyscy tego żałują - zwłaszcza, że długość życia kodu np. w Pratermie jest dość duża. Doxygen poza tym, że pozwala generować ładną dokumentację, która pozwala się zorientować w strukturze kodu i służyć jako reference do funkcji i typów danych, wymusza także pewien styl komentowania, który na dłuższą metę okazuje się całkiem sensowny. Zapewnia także generację dokumentacji w różnych formatach - jako strony HTML, jako Latex, RTF lub strony podręcznika man. Obsługuje wiele języków, w tym język polski.
Aby uzyskać dokumentację kodu, należy po pierwsze opisać odpowiednio kod (za pomocą odpowiednio sformatowanych komentarzy), a po drugie uruchomić Doxygena z odpowiednim plikiem konfiguracyjnym. Oba te elementy są pokrótce opisane poniżej. Pełny opis wszystkich opcji można znaleźć w dokumentacji programu.
Poprzedni | Spis treści | Następny |
Dodatki | Początek rozdziału | Komentowanie kodu |