Ako písať „pekný“ kód? Programovanie v jazyku JAVA

1. Ako písať „pekný“ kód? Programovanie v jazyku JAVA Mgr. Lukáš Zmuda lukas.zmuda@gmail.com

2. definícia názvy premenných, funkcií, tried objekty formátovanie „Pekný“ kód - definícia • exaktná definícia neexistuje; každý si tvorí vlastnú definíciu • existujú zásady, ktoré ak budeme dodržiavať, kód bude prehľadnejší, čitateľnejší, použiteľnejší Mgr. Lukáš Zmuda Ako písať „pekný“ kód?

3. definícia názvy premenných, funkcií, tried objekty formátovanie Názvy premenných, funkcií, tried Pravidlo č.1. Názvy premenných volíme podľa toho, akú informáciu v sebe nesú. Názvy metód (funkcií) naopak podľa toho čo vykonávajú. booleanzistiCiJeTentoRokPriestupny(int x) { if(x %4 == 0) returntrue; else returnfalse; } ? booleanjePriestupny(int rok) { if(rok %4 == 0) returntrue; else returnfalse; } Pozn.: Algoritmus je iba ilustračný a nezohľadňuje všetky výnimky v pravidlách výpočtu priestupného roku (priestupné nie sú roky deliteľné 100, pokiaľ nie sú zároveň deliteľné 400) Mgr. Lukáš Zmuda Ako písať „pekný“ kód?

4. definícia názvy premenných, funkcií, tried objekty formátovanie Názvy premenných, funkcií, tried Pravidlo č.1. Názvy premenných volíme podľa toho, akú informáciu v sebe nesú. Názvy metód (funkcií) naopak podľa toho čo vykonávajú. Všetko s mierou!!! for(int premennaCyklu = 0; premennaCyklu<100; premennaCyklu++) Mgr. Lukáš Zmuda Ako písať „pekný“ kód?

5. definícia názvy premenných, funkcií, tried objekty formátovanie Názvy premenných, funkcií, tried Pravidlo č.2. Metódy (funkcie) by mali byť krátke. Metóda by mala vykonávať iba jednu činnosť. classKosik{ ... public KosikpridajDoKosika(Produktprodukt){ this.vyprazdniKosik(); this.kosik.append(produkt); return this.kosik; } ... } • vykonáva daná metóda činnosť, ktorú má v popise? • neočakávaná činnosť vyprazdniKosik() Mgr. Lukáš Zmuda Ako písať „pekný“ kód?

6. definícia názvy premenných, funkcií, tried objekty formátovanie Konvencie v jazyku Java • i a j sú celočíselné indexy • konštanty sa píšu IBA_VELKYMI_PISMENAMI a slová v nich sú oddelené podčiarkovníkom • názvy tried a rozhraní sa píšu veľkými začiatočnými písmenami; v prípade viacslovného názvu každé slovo začína veľkým písmenom – pr.: NazovTriedyAleboRozhrania • názvy premenných a metód začínajú malým písmenom, ale vo zvyšných prípadoch sa riadi predchádzajúcou konvenciou – nazovPremennejAleboMetody • podčiarkovník sa ako oddeľovač slov nepoužíva, výnimkou sú iba názvy, ktoré sa celé píšu veľkými písmenami • predpony get a set sa používajú pre prístupové metódy Pozn.: Viac o konvenciách v jazyku v Java nájdete v publikácii TheElementsofJavaStyle Mgr. Lukáš Zmuda Ako písať „pekný“ kód?

7. definícia názvy premenných, funkcií, tried objekty formátovanie Objekty Pravidlo č.3. Objekty píšeme malé. Každá trieda (objekt) by mal mať na starosti iba jednu vec. Mgr. Lukáš Zmuda Ako písať „pekný“ kód?

8. definícia názvy premenných, funkcií, tried objekty formátovanie Objekty Pravidlo č.4. Zapuzdrujem, zapuzdruješ, zapuzdrujeme. vs. Mgr. Lukáš Zmuda Ako písať „pekný“ kód?

9. definícia názvy premenných, funkcií, tried objekty formátovanie Formátovanie importjava.util.Scanner; publicclassTrojuholnik {publicstaticvoid main(String[] args) { Scanner sc = new Scanner(System.in);intn=integer.parseInt(sc.nextLine()); for (int i=1;i<=n; i++){for(intj=1;j<=i;j++){System.out.print("*");} System.out.println();}sc.close();}} vs. importjava.util.Scanner; publicclassTrojuholnik { publicstaticvoid main(String[] args) { Scannersc = newScanner(System.in); int n = Integer.parseInt(sc.nextLine()); for (int i = 1; i <= n; i++) { for (int j = 1; j <= i; j++) { System.out.print("*"); } System.out.println(); } sc.close(); } } • v Eclipse pomocou klávesovej skratky Ctrl-Shift-F naformátujeme kód Mgr. Lukáš Zmuda Ako písať „pekný“ kód?

10. definícia názvy premenných, funkcií, tried objekty formátovanie Doporučená literatúra • Dokonalý kód • Vydané: Computer Press 2006, ISBN: 802510849X • Kniha stmeľuje užitočné typy s efektívnymi vývojovými stratégiami, ktoré kedysi museli vývojári zháňať a získavať od skúsenejších kolegov • Širší uhol pohľadu na vývoj softvéru Mgr. Lukáš Zmuda Ako písať „pekný“ kód?