Wątek przeniesiony 2020-04-14 17:48 z C/C++ przez kq.

Dokumentowanie kodu

0

Posiada projekt z C oraz Python

Do dokumentowania pythona używam sphinx
do dokumentacji C planuję doxygen

Czy jest to dobry pomysł?

1

Myślałem że już nikt nie dokumentuje kody. Przecież teraz jest Clean Code, samodokumentujący się kod, opisowe testy w stylu HSpec, Spec2 oraz Spock. I przecież nikt nigdy tych generowanych komentarzy nie czyta.
No chyba że bibliotekę wydajesz. To wtedy to ma sens

0

W poprzedniej pracy korzystałem z doxygena i myślę, że to dobry pomysł. Może człowiek nie patrzy do wygenerowanej dokumentacji, ale czasem dobrze w kodzie spojrzeć na opis jakieś metody czy jej parametrów. No ale wiadomo nie ma co przeginać z komentowaniem wszystkiego jak leci.

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