abclinuxu.cz AbcLinuxu.cz itbiz.cz ITBiz.cz HDmag.cz HDmag.cz abcprace.cz AbcPráce.cz
AbcLinuxu hledá autory!
Inzerujte na AbcPráce.cz od 950 Kč
Rozšířené hledání
×
dnes 09:33 | IT novinky

Dnes končí bezpečnostní konference Black Hat USA 2020 (Twitter) a začíná bezpečnostní konference DEF CON 28 (Twitter). Kvůli onemocnění COVID-19 ne v Las Vegas, ale pouze virtuálně. Na konferenci DEF CON naplánované přednášky jsou již k dispozici na DEF CON Media Serveru a na YouTube.

Ladislav Hagara | Komentářů: 0
dnes 07:33 | Nová verze

Po více než pěti letech byla vydána nová verze 1.7 multiplatformního grafického editoru Pinta (Wikipedie). Přehled novinek v poznámkách k vydání.

Ladislav Hagara | Komentářů: 0
dnes 00:33 | Komunita

V září loňského roku Richard Stallman rezignoval na funkci prezidenta Free Software Foundation (FSF). Včera byl zvolen nový prezident. Je jím Geoffrey Knauth (Twitter).

Ladislav Hagara | Komentářů: 6
včera 18:11 | Nová verze

Mozilla na svém blogu informuje o Enhanced Tracking Protection (ETP) 2.0 aneb nové verzi rozšířené ochrany proti sledování ve Firefoxu. Nová verze chrání také před technikou redirect tracking a každých 24 hodin smaže sledovací cookies. Podrobněji na blogu věnovaném bezpečnosti.

Ladislav Hagara | Komentářů: 0
včera 14:33 | Nová verze

The Document Foundation oznámila na svém blogu vydání nové verze 7.0 svobodného kancelářského balíku LibreOffice. Podrobný přehled nových vlastností i s náhledy v poznámkách k vydání (cs) nebo také na Youtube a PeerTube.

Ladislav Hagara | Komentářů: 8
včera 13:33 | Nová verze

Byla vydána nová stabilní verze 3.2 (3.2.1967.41) webového prohlížeče Vivaldi (Wikipedie). Přehled novinek v příspěvku na blogu. Zdůraznit lze vylepšený obraz v obraze. Nejnovější Vivaldi je postaven na Chromiu 84.0.4147.108.

Ladislav Hagara | Komentářů: 17
včera 01:11 | Nová verze

Wayfire, kompozitní správce oken inspirovaný Compizem běžící nad Waylandem, byl vydán ve verzi 0.5.0. Zdrojové kódy jsou k dispozici na GitHubu. Videoukázky na YouTube.

Ladislav Hagara | Komentářů: 2
4.8. 12:22 | Komunita

Neziskové technologické konsorcium Linux Foundation rozšířilo seznam svých oficiálních projektů. Nejnovějším projektem je Open Source Security Foundation (OpenSSF), jehož cílem je zvýšit bezpečnost open source softwaru. Více například v příspěvcích na blozích GitHubu nebo Microsoftu.

Ladislav Hagara | Komentářů: 5
4.8. 11:44 | Nová verze

Byla vydána verze 3.1 webového aplikačního frameworku napsaného v Pythonu Django (Wikipedie). Přehled novinek v poznámkách k vydání.

Ladislav Hagara | Komentářů: 0
4.8. 01:11 | Nová verze

Svobodná federalizovaná sociální síť Mastodon byla aktualizována. Vydání 3.2 mj. přepracovává audio přehrávač, zlepšuje zabezpečení přihlášení aj.

Fluttershy, yay! | Komentářů: 0
Dokážete si představit, že by váš hlavní počítač (desktop, notebook) byl v současné době založen na architektuře jiné než x86 (x86_64)? Například ARM, POWER, RISC-V,…
 (9%)
 (12%)
 (57%)
 (16%)
 (6%)
Celkem 157 hlasů
 Komentářů: 11, poslední včera 08:59
Rozcestník

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

2.8.2010 10:08 | Přečteno: 1654× | 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.        

Hodnocení: 75 %

        špatnédobré        

Anketa

Používáte javadoc?
 (73 %)
 (9 %)
 (6 %)
 (6 %)
 (6 %)
Celkem 67 hlasů

Tiskni Sdílej: Linkuj Jaggni to Vybrali.sme.sk Google Del.icio.us Facebook

Komentáře

Vložit další komentář

2.8.2010 10:21 podlesh | skóre: 38 | Freiburg im Breisgau
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc?
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.
2.8.2010 10:23 Filip Jirsák | skóre: 67 | blog: Fa & Bi
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc?
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.
2.8.2010 10:43 void
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc?
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í".
2.8.2010 11:11 Trained.Monkey | skóre: 12 | blog: monkey
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc?
Upravil jsem text aby se to nepletlo.
2.8.2010 11:17 void
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc?
OK. Já čtu Javadoc dokumentaci každý den, kdy (v Javě) programuju.
2.8.2010 10:48 Ladicek | skóre: 28 | blog: variace | Havlíčkův brod
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc?
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 :-)
Ještě na tom nejsem tak špatně, abych četl Viewegha.
xkucf03 avatar 2.8.2010 17:40 xkucf03 | skóre: 49 | blog: xkucf03
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc?
+1
Mám rád, když se lidé přou, znamená to, že vědí, co dělají, a že mají směr. Frantovo.cz, SQL-DK, Relational pipes
2.8.2010 16:24 rudyment
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc dokumentaci?
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 avatar 2.8.2010 17:39 xkucf03 | skóre: 49 | blog: xkucf03
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc dokumentaci?
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.
Mám rád, když se lidé přou, znamená to, že vědí, co dělají, a že mají směr. Frantovo.cz, SQL-DK, Relational pipes
2.8.2010 21:21 Leoš Literák | skóre: 74 | blog: LL | Praha
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc dokumentaci?
jo, ale stve me, jak byvaji odflaknute, takze nekdy nezbyde, nez ztracet cas ctenim kodu
Zakladatel tohoto portálu. Twitter, LinkedIn, blog, StackOverflow
2.8.2010 22:28 lok
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc dokumentaci?
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)?
3.8.2010 11:04 Trained.Monkey | skóre: 12 | blog: monkey
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc dokumentaci?
Asi ne, Skala je v tomhle trochu divna, napriklad ma vicenasobnou dedicnost (traits).
3.8.2010 05:17 Andrej | skóre: 47 | blog: Republic of Mordor | Zürich
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc dokumentaci?

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í.

ǑǦŹǓǕǙǞǺǨȞȬḔḦḰḾṊṎṸẄẌỖ
3.8.2010 14:02 Trained.Monkey | skóre: 12 | blog: monkey
Rozbalit Rozbalit vše Re: Používáte ještě Javadoc dokumentaci?
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.

Založit nové vláknoNahoru

ISSN 1214-1267   www.czech-server.cz
© 1999-2015 Nitemedia s. r. o. Všechna práva vyhrazena.