W Eclipse-CDT, gdy najeżdżam na jakąś funkcję np. z stdio.h wyświetla mi się ładny dymek wraz z krótkim komentarzem dołączonym do tej funkcji. Robię podobnie i gdy potrzeba to nad deklaracją funkcji w modul.c piszę krótki komentarz. Prawidłowo takie rzeczy powinno się opisywać w modul.c czy modul.h ?
0
1
Zdajesz sobie sparwę z tego że biblioteki często udostępnia się w wersji skompilowanej wraz z nagłówkiem? Wtedy te twoje komentarze w pliku .c są psu na budę...
0
Dobra, ale nie zawsze. Czyli rozumiem, że aby było ładnie i fajnie trzeba jeszcze napisać dokumentację.... a jak paczkuję taką "bibliotekę" mam w paczce różne pliki typu ChangeLog, TODO, AUTHORS, README itd... w jakim pliku dostarcza się dokumentację?
1
google: doxygen