Generowanie dokumentacji
Po odpowiednim udokumentowaniu kodu, przyszedł czas na zobaczenie efektu swojej pracy w postaci plików HTML z naszą upragnioną dokumentacją. Zakładam oczywiście, że zastosowałeś się do początku artykułu i zainstalowałeś samo Doxygen.
Tutaj Doxygen miło zaskakuje, ponieważ dostarcza nam graficzne narzędzie do ustawienia projektu dokumentacji. Napisanie pliku tekstowego z tym, co wygeneruje, siedząc z dokumentacją „w ręku”, naprawdę zajęłoby od groma czasu. W dystrybucjach Linuksa wystarczy uruchomić doxywizard. Komentować obsługi tego narzędzia nie będę, w końcu artykuł ten jest przeznaczony dla deweloperów, którzy z pewnością sobie poradzą z ustawieniem wszystkiego w tym programie, zwłaszcza, że po najechaniu na etykietę ustawienia, dostajemy przemiłą podpowiedź. :-)
 | Za ten artykuł podziękowano 5 raz(y). Chcesz i Ty ? |
2 Comments
Podany przykład dla typu zmiennej nie zadziała (nie wyświetli się opis zmiennej w wygenerowanej dokumentacji). Przy tagu @var należy dodać na końcu nazwę zmiennej, czyli dla tego przykładu „@var typ_zmiennej $example”. Testowane na doxygen 1.7.4.
Mówisz o zwykłej zmiennej? Dla zmiennych w klasach, czyli właściwości, powyższy sposób u mnie działa.