Dobrze sformułowany komentarz, przekazuje odbiorcy sporo przydatnych informacji. Po drugiej stronie szali, mogą pojawić się komentarze przynoszące więcej szkody niż pożytku. Warto mieć na uwadze to, że takie istnieją. A ich skutkiem może być dezinformacja. Celem komentarza jest „dopowiedzenie” tego, czego developer nie jest w stanie umieścić w kodzie.
Jak napisać komentarz?
Jako java developer zapewne nie raz się spotkasz z potrzebą napisania swojego komentarza. Co trzeba zrobić? Poniżej znajdziesz kilka wskazówek.
- rozpoznaj sytuacje-> zastanów się, czy nie ma innego sposobu na przekazanie informacji niż komentarz
- komentarz powinien być krótki, zrozumiały i precyzyjny
- przejrzyj swój kod, upewnij się, że jest „czysty”; może lepszy rozwiązaniem niż pisanie komentarza, jest poprawa kodu?
Pamiętaj! Przejrzysty, czysty kod z małą ilością komentarzy jest o wiele bardziej przydatny w pracy, niż ten obszerny, zaśmiecony zbędnymi komentarzami. Programiści powinni pisać kod, a nie próbować rozwiązywać skomplikowane/ nawarstwione ilości źle napisanego kodu.
Cel komentarzy
- ułatwienie pracy developerom
- ułatwienie zrozumienia kodu będącego źródłem
- mogą pełnić rolę podsumowania
Sięgnij po więcej–> kursy GREAT
Zespół GREAT