Používáte ještě Javadoc dokumentaci?

2.8.2010 10:08 | Přečteno: 1799× | poslední úprava: 2.8.2010 11:08

Jednou z výhod Javy jsou standardní nástroje, v neposlední řadě pak Javadoc. V posledních letech ale nastala exploze IDE a opensource knihoven. Mnohdy je pak jednodušší studovat zdrojáky přímo.

Takže mám jednoduchou otázku: Kdy jste naposledy otevřeli dokumentaci generovanou Javadocu? U mě je to hodně sporadické, většinou mi odkaz na vyjede z Google a i v tom případě se snažím najít originální zdroják. Není to závislé na kvalitě dokumentace, spíš jsem si už zvyknul číst zdroják. Jediná výjimka jsou closedsource knihovny, ale ty používám hodně sporadicky.

Důvod proč se ptám: přemýšlím o migraci jednoho projektu do jazyku Scala. Jednou z překážek je dokumentační nástroj. Scala má něco podobného s názvem Scaladoc, ale ten se neintegruje s Javadocem. Vznikne mix dvou jazyků z nichž každý bude mít jiný dokumentační nástroj a oddělenou dokumentaci. A jedním z řešení je prostě žádný *Doc nemít a odkázat rovnou na zdrojové kódy.        

Anketa

Komentáře

[podlesh]

Někdy člověk zdrojáky nemá (proprietární knihovny) a pak je rád i za javadoc. Samozřejmě je to většinou k ničemu, knihovna s dostatečně popsaným API je vzácnou výjimkou - proto je lepší se držet opensource.

[Filip Jirsák]

Ve zdrojáku je zbytečně moc podrobností. Nejčastěji stačí názvy tříd a metod, pak případně JavaDoc. Do zdrojáku koukám až když v JavaDocu něco chybí, když je to přílišný detail na to, aby to bylo v dokumentaci, případně když ta knihovna dělá zjevně něco jiného, než co tvrdí dokumentace.

[void]

IMHO dochází v textu k záměně Javadocu a jeho výstupu. A co se týče IDE, myslím si, že aspoň nějaká Javadoc používají "v pozadí".

[Trained.Monkey]

Upravil jsem text aby se to nepletlo.

[void]

OK. Já čtu Javadoc dokumentaci každý den, kdy (v Javě) programuju.

[Ladicek]

Nevím teda, jak to autor myslí, ale výstupy javadocu prakticky nečtu. Nechávám si dokumentaci zobrazovat IDEčkem, které ji z dokumentačních komentářů ve zdrojácích formátuje výrazně hezčeji

[xkucf03]

+1

[rudyment]

Javadoc proletím mnohem rychleji a když je slušně napsaný, dá se i lépe číst. Ke zdrojáku se obracím až tehdy, když je mi v Javadocu něco nejasné.

[xkucf03]

Počítá se v anketě do „Ano, prakticky pořád“ i čtení Javadocu přes IDE? Že bych si pročítal JavaDoc jako HTML stránky, to moc ne, ale v IDE jako kontextovou nápovědu ho používám pořád – jde hlavně o ty komentáře a anotace, než o to vygenerované HTML. Zdrojáky jsou fajn (a asi bych ani knihovnu bez zdrojáků nepoužíval), ale není nutné se do nich pořád koukat – resp. dobrá knihovna by měla mít dobře navržené a zdokumentované rozhraní, abych z něj chápal, co mají jednotlivé metody dělat a k čemu slouží jednotlivé třídy – do jejich zdrojáků se budu dívat, až je budu chtít upravit, inspirovat se, hledat chybu… ale pro běžné používání by neměly být potřeba.

[Leoš Literák]

jo, ale stve me, jak byvaji odflaknute, takze nekdy nezbyde, nez ztracet cas ctenim kodu

[lok]

Javadoc pouzivam velmi sporadicky. Myslim, ze doxygen je lepsi volbou. Btw nezvladl by doxygen vygenerovat dokumentaci pro obe casti tveho projektu (jak java tak scala)?

[Trained.Monkey]

Asi ne, Skala je v tomhle trochu divna, napriklad ma vicenasobnou dedicnost (traits).

[Andrej]

JavaDoc a Doxygen jsou nezbytnost. Vždyť právě díky nim je IDE užitečné. Pokud například používám nějakou standardní knihovnu, prolézání zdrojáků mě až tak moc nezajímá. Naopak možnost přečíst si ihned u každé vonalé funkce její dokumentaci je přímo k nezaplacení.

[Trained.Monkey]

Nechal jsem si to projit v hlave. Nejsem moc dobry ve psani javadocu znacek. Rozhodne ma dokumentace neni dost dobra, aby se z ni dalo vycist chovani v neobvyklych prikladech.

Takze misto toho se vic soustredim na priklady a unit testy. Do dokumentace tak misto odkazu na vystup z javadocu dam odkaz na priklad pouziti.