Doxygen - gdzie umieszczać komentarze
: niedziela 02 kwie 2017, 14:45
Witam, bawię się trochę doxygenem i mam pytanko - gdzie lepiej trzymać komentarze do funkcji - w plikach h czy c/cpp? Chodzi mi o ta warstwe opisu funkcji, parametrów itp.
Np Eclipse/Atollic itp po najechaniu kursorem na funkcję wyświetla nam jej zawartość z pliku .c łacznie z górnym komentarzem - czy iść w tym kierunku? Z drugiej strony głupio plik h zostawić bez komentarzy (można zastosować nie doxygenowskie i ich nie będzie w dokumentacji).
Ktoś ma jakieś doświadczenie w tym temacie?
Np Eclipse/Atollic itp po najechaniu kursorem na funkcję wyświetla nam jej zawartość z pliku .c łacznie z górnym komentarzem - czy iść w tym kierunku? Z drugiej strony głupio plik h zostawić bez komentarzy (można zastosować nie doxygenowskie i ich nie będzie w dokumentacji).
Ktoś ma jakieś doświadczenie w tym temacie?