doxygen a dokumentacja

0

Hej

dokumentuje projekty doxygenem, cos mi sie kojarzy, ze dokumentacje tworzy sie tylko w plikach *.h (a *.cpp sie nie komentuje), prawda to ?

0

Doxygen generuje ci dokumentacje tylko dla klas/namespaców. Jak i gdzie chciałbyś mieć komentarze z kodu?

0

Można dokumentować albo po stronie nagłówków, albo po stronie pliku z kodem źródłowym. Obie metody działają.
Zaletą dokumentowania w nagłówkach jest to, że dowolne IDE może pasować tę dokumentację i ją pokazywać w podpowiedziach. Wada jest taka, że zwiększają one długość nagłówków i czas kompilacji.
Jak masz dokumentację w cpp to musisz ją potem skonwertować do odpowiedniego formatu i dostarczyć w tym formacie razem z biblioteką.
Przykładowo Qt dokumentowane jest w plikach cpp.

1 użytkowników online, w tym zalogowanych: 0, gości: 1