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 13:22 | Zajímavý projekt

Více než 60 moderních telefonů má díky práci týmu dobrovolníků SOMainline šanci na zařazení do oficiálního linuxového jádra. Patche pro podporu chipsetu SD630 a SD660, kterým jsou tyto telefony poháněny, jsou postupně začleňovány. Tým se soustředí na zprovoznění klasických linuxových distribucí pro telefony, ale věnuje se i zprovoznění běžného AOSP. Další tým vývojářů postmarketOS již delší dobu pracuje na podpoře chipsetu MSM8953, který umožňuje vdechnout život dalším nejméně 30 telefonům vydaných v letech 2017 a 2018.

David Heidelberg | Komentářů: 0
dnes 08:00 | Komunita

Svobodný kancelářský balík LibreOffice slaví 10 let od svého vzniku. Projekt byl představen 28. září 2010.

Ladislav Hagara | Komentářů: 8
dnes 07:00 | Pozvánky

Ve dnech 15. až 17. října 2020 se bude konat společná openSUSE + LibreOffice konference. Původně měla konference probíhat v Norimberku, ale vzhledem k situaci bude probíhat online. Konference již zveřejnila program. Naplánováno je několik desítek přednášek. Registrace a podrobnosti naleznete na stránce konference.

Zdeněk Crhonek | Komentářů: 0
včera 18:11 | Zajímavý software

SimulIDE je realtimový simulátor elektronických obvodů. Podporuje také PIC, AVR a Arduino. K dispozici je verze 0.4.13. Vývojáře lze podpořit na Patreonu.

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

Virtual Machine Manager aneb virt-manager (Wikipedie), tj. GUI pro správu virtuálních strojů podporovaných knihovnou libvirt, byl vydán ve verzi 3.0.0. Přehled novinek v příspěvku na blogu. Zdůrazněna je nová volba --cloud-init.

Ladislav Hagara | Komentářů: 4
včera 11:11 | Zajímavý software

Vývojáři programovacího jazyka Swift na svém blogu oznámili, že společností Apple v červnu představená knihovna Swift System je již open source a byla do ní přidána podpora Linuxu. Jedná se o knihovnu poskytující idiomatická rozhraní k systémovým voláním.

Ladislav Hagara | Komentářů: 0
26.9. 15:11 | Nová verze

Byl vydán Debian 10.6, tj. šestá opravná verze Debianu 10 s kódovým názvem Buster. Řešeny jsou především bezpečnostní problémy, ale také několik vážných chyb. Instalační média Debianu 10 lze samozřejmě nadále k instalaci používat. Po instalaci stačí systém aktualizovat.

Ladislav Hagara | Komentářů: 1
25.9. 23:11 | Bezpečnostní upozornění

Byly zveřejněny informace o bezpečnostní chybě BLURtooth (CVE-2020-15802) v Bluetooth 4.2 a 5.0 v Cross-Transport Key Derivation (CTKD). Útočník může provádět MITM nebo navázat spojení s libovolným zařízením. Podrobnosti v článku (pdf).

Ladislav Hagara | Komentářů: 1
25.9. 21:44 | IT novinky

Byly zveřejněny informace o úniku zdrojových kódů Windows XP.

Ladislav Hagara | Komentářů: 31
25.9. 15:22 | Zajímavý projekt

Chcete proniknout do tajů gitu? Klikněte na Learn Git Branching. Vizuální a interaktivní tutoriál ve webovém prohlížeči.

Ladislav Hagara | Komentářů: 1
Používáte aplikaci eRouška?
 (19%)
 (3%)
 (2%)
 (11%)
 (51%)
 (8%)
 (6%)
Celkem 453 hlasů
 Komentářů: 35, poslední 20.9. 21:50
Rozcestník

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

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