W dzisiejszej lekcji będzie przede wszystkim o pomaganiu sobie. Bo tak należy myśleć o dokumentacji kodu w postaci javadoc’ów.
Javadoc to narzędzie dostarczane wraz z Javą, które na podstawie kodu i dodatkowych opisów w postaci specjalnie sformatowanych komentarzy tworzy ustrukturyzowaną i spójną dokumentację kodu. Taka dokumentacja ma jedno oczywiste zastosowanie — ułatwienie pracy innym programistom z Twoim kodem poprzez wyjaśnienie za co odpowiadają poszczególne klasy, metody, pola itp. Drugie, mniej oczywiste i często zapominane, ale jakże ważne — aby pomóc sobie zrozumieć jak podzielimy algorytm / logikę na elementy, jak będą ze sobą współdziałały i co będzie ich efektem.
Czytaj dalej →