30.5. Konkluzja
Dobra dokumentacja techniczna jest cennym elementem każdego projektu. Obecnie do utworzenia naprawdę dobrej dokumentacji technicznej wystarczy połączenie tekstu napisanego przez człowieka i dokumentacji wygenerowanej automatycznie przez odpowiednie oprogramowanie. Niektóre popularne projekty typu open source, w tym frameworki Hibernate[114] i Spring[115], oferują dokumentację najwyższej jakości, łączącą w sobie właśnie komentarze pisane przez samych programistów z generowaną automatycznie dokumentacją interfejsów API. Twierdzenie, że druga część tej dokumentacji może w pełni zastąpić pierwszą, byłoby jednak błędem.
Chociaż w typowych projektach komercyjnych ograniczenia budżetowe mogą wykluczać możliwość sporządzania tak dokładnej ...
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.
