Powrót do poprzedniego menu.
Patrząc oczami programisty piszącego implementację pisanie zwykłych komentarzy wewnątrz implementacji są jedną z najbardziej nielubianych czynności.
Jeśli jednak spojrzymy na to oczami innego programisty, który musi dokonać poprawek w kodzie napisanym przez kogoś innego, to komentarze te mogą mu zdecydowanie ułatwić pracę.
Każdemu z was zdarzyło się "grzebać" w kodzie napisanym przez kogoś innego. Sami powiedzcie, o ile łatwiej się czyta kod, jeśli zawiera dobre komentarze.
Powiedzcie, ile razy zdarzyło się wam nie rozumieć sposobu działania czyjegoś algorytmu?
A ile razy po wielu godzinach nieustannych prób zmiany koncepcji działania czyjejś implementacji stwierdziliście "to trzeba przepisać"?
Czy byłoby wam łatwiej wykonać te poprawki, jeżeli wasz poprzednik porządnie skomentowałby kod?
A powiedzcie mi, ile razy zdarzyło się wam wrócić do własnego kodu napisanego ileś miesięcy wcześniej? Czy zdarzało się wam w pierwszy momencie patrzenia na kod
pomyśleć na przykład "czemu ja to tak napisałem?", albo przykładowo "dlaczego ja w tym przypadku przeskakuję iterację pętli?".
Najbardziej porządane jest komentowanie:
- wszelkich algorytmów, sposobów ich działania krok po kroku,
- działania wszelkich pętli oraz sensu ich użycia,
- synchronizacji wątków/metod,
- zmian stanów obiektów.
Tak dla ciekawości podam, że jedna z miar jakości kodu wspomnianych na stronie głównej mówi, że prawidłowy stosunek ilości kodu do komentarzy wynosi 50/50 %.
Wynika z tego, że komentarze powinny zajmować co mniej więcej tyle samo linii kodu, co implementacja.
Powrót do poprzedniego menu.