Online kurz programování Java 3 (ZDARMA) – komentáře

A je tu dal­ší díl pro­gra­mo­vá­ní v jazy­ce Java. Pro­gra­mo­vá­ní vysvět­lu­je­me tak jed­no­du­še, jako by vám to vysvět­lo­val kama­rád u piva! Není tře­ba nic umět pro začá­tek a nemu­sí­te nic insta­lo­vat. Cvič­ný kód spus­tí­te pří­mo na této stránce.

Obsah kurzu

Komentáře

Co kdy­bys­te chtě­li někam do pro­gra­mu při­psat poznám­ku, kte­rou Java nepře­čte, ale vy ano? Tro­chu jako když napí­še­te dopis a mezi řád­ky něco při­pí­še­te nevi­di­tel­ným inkous­tem. Adre­sát taj­nou zprá­vu nevi­dí, ale vy víte, že sta­čí zprá­vu pře­jet žeh­lič­kou nebo posví­tit UV svět­lem, a zprá­va se objeví.

K čemu by ale tako­vá skry­tá zprá­va byla v pro­gra­mu? Pomo­cí ní bys­te si do kódu moh­li napsat růz­né poznám­ky, tře­ba jak kód fun­gu­je, nebo proč jste pro­gram napsa­li tak, jak jste ho napsa­li. Poznám­ka by vám pomoh­la, kdy­bys­te se muse­li ke slo­ži­té­mu kódu vrá­tit tře­ba po roce a něco v něm upra­vit. Nebo kdy­by po vás kód někdo v budouc­nos­ti pře­vzal a měl by v něm udě­lat úpra­vy. Nebo kdy­bys­te pro­gra­mo­va­li teamově.

Tako­vá poznám­ka, kte­rou vy vidí­te, ale Java jí igno­ru­je, se nazý­vá komen­tář (angl. com­ment[koment]). Může­te buď skrýt jeden řádek (pou­žij­te //) nebo něko­lik řád­ků (na začá­tek komen­tá­ře dej­te /* a na konec dej­te */). Skry­tí jed­no­ho řád­ku se v ang­lič­ti­ně nazý­vá sin­gle-line com­ment [sin­gl lajn koment], skry­tí více řád­ků je mul­ti-line com­ment [mul­ti­lajn koment] nebo také block com­ment [blok koment]. Tady je ukázka:

• Jste na smart­pho­nu? Kód i výsle­dek v čer­ném okně může­te prs­tem posou­vat dole­va a dopra­va, abys­te vidě­li celé řádky.
• Jste na iPho­ne, iPa­du? Jdě­te do Nastavení>Safari>Nesledovat napříč strán­ka­mi a vypně­te tuto funk­ci.

Kolik tako­vých komen­tá­řů do kódu psát? Odpo­věď zní: tak ako­rát. A pod­le toho, co potře­bu­je­te. Když nena­pí­še­te žád­né komen­tá­ře a po dvou letech bude­te chtít upra­vit roz­sáh­lý kód, mož­ná u někte­rých čás­tí bude­te dlou­ho pře­mýš­let, co vlast­ně děla­jí, a tlouct hla­vou do zdi, že jste si to do kódu nena­psa­li. Na dru­hou stra­nu, když je v něja­kém kódu hod­ně komen­tá­řů, a ten kód se čas­to mění, pro­gra­má­to­ři obvykle nestí­ha­jí aktu­a­li­zo­vat i komen­tá­ře. Ty jsou potom zasta­ra­lé (už nese­dí s kódem) a mís­to aby pomá­ha­ly, vytvá­ří zmatek.

Komen­tá­ře se taky dají pou­žít na skry­tí kódu, kte­rý nechce­te spouš­tět, ale ani vyma­zat (hodí se to na experimentování).

Pro zají­ma­vost, exis­tu­je ješ­tě tře­tí druh komen­tá­ře – doku­men­tač­ní komen­tář (docu­men­tati­on com­ment [doku­men­tejšn koment]). Z těch­to komen­tá­řů se auto­ma­tic­ky gene­ru­je doku­men­ta­ce k vaše­mu pro­gra­mu. (Dělá to Java­doc, sou­část JDK – Java Deve­lo­p­ment Kit. Jak se Java­doc a doku­men­tač­ní komen­tá­ře pou­ží­va­jí, si vysvět­lí­me poz­dě­ji). Co je to ta doku­men­ta­ce? Je to jaký­si návod na váš pro­gram, jeho popis. Návod se vyge­ne­ru­je auto­ma­tic­ky stisk­nu­tím tla­čít­ka a obsa­hu­je i infor­ma­ce z doku­men­tač­ních komen­tá­řů. Uži­teč­ná věc pro pokro­či­lé, ale vám zatím sta­čí vědět, že to exis­tu­je. Začá­tek doku­men­tač­ní­ho komen­tá­ře je /** a konec */. Tady je příklad:

/** Autorem tohoto programu je:
Josef Novák. */

Pokra­čuj­te dal­ším dílem: Onli­ne kurz pro­gra­mo­vá­ní Java 4 – vstup z klá­ves­ni­ce.

Obráz­ky: Unspla­sh: Ele­va­te, Direct­Glow LLC.