Java — dokumentace v hrsti

Dokumentace k API (J2SE, J2EE, J2ME), se kterým se běžně setkává vývojář Javy je součástí SDK. Problém nastává v případě různých frameworků a komponent třetí strany, bez kterých se vývojář neobejde. Ve většině případů se používá binární distribuce ve formě jaru, která se přidá na classpath. Díky tomu nám IDE může nabídnout službu ve formě code assistent.

Problém nastane ve chvíli, kdy potřebujeme dokumentaci tzv. JavaDoc k samotnému API, které využíváme. V takovém případě máme dvě možnosti. Stáhnout si zdrojové soubory, které umí zpracovat IDE a Javadoc nabídnout nebo dokumentaci najít a stáhnout přímo od “výrobce”.

Ani jedna z možností není ideální nebo alespoň ne pro mě. Velice mě proto potěšila aktivita serveru Javalobby, který nastartoval online shromaždiště javovských API JDocs. K dnešku je na JDocs zařazeno a indexováno celkem 106 API, které je možné online prohledávat.

Tato zpráva je sama o sobě potěšující. Bohužel se objevil problém s dokumentací k J2SE, J2EE, J2ME, na které si dělá výhradní právo Sun. Sun sice požádal o stažení dokumentace, ale k dnešku je tato dokumentace stále dostupná. Více o tomto problému na serveru TheServerSide JDocs.com: Sun protects itself, Javalobby wants to move on

Pro uživatele Eclipse je tato zpráva ještě potěšující. Existuje plugin, díky kterému je možné prohledávat API na JDocs z pohodlí IDE.

Popis instalace pluginu

Help >> Software Updates >> Find and Install >> Search for new features to install >> New remote Site >> Name:JDocs Search plugin, URL:http://www.jdocs.com/plugins/eclipse/
 >> ok >> vybrat JDocs Search plugin >> next >> vybrat >> next >> install

Dagblog související články

• Javadoc zdarma
• Dokumentace k Jave ve formátu HTMLHelp nebo WinHelp