1.7. Generowanie dokumentacji za pomocą narzędzia Javadoc
Dokumentacja techniczna jest ważnym elementem każdego projektu, a narzędzie Javadoc jest jednym z kamieni węgielnych świata dokumentacji technicznej w Javie. Javadoc generuje czytelny, wygodny zbiór dokumentacji interfejsu API na podstawie naszego kodu Javy — taka dokumentacja może stanowić cenną pomoc jako narzędzie komunikacji ułatwiające członkom zespołu dobre zrozumienie działań podejmowanych przez pozostałych programistów. Dobra dokumentacja Javadoc wymaga oczywiście właściwie napisanych komentarzy w ramach danego kodu źródłowego (z podobnymi wymaganiami mamy do czynienia w przypadku wszystkich narzędzi dokumentujących). Dokumentacja narzędzia Javadoc z definicji jest materiałem niskopoziomowym ...
Get Java. Praktyczne narzędzia now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
