Čo sú Java komentáre a ako ich vytvárať

V jazyku Java existujú tri rôzne typy komentárov. Komentáre môžete použiť na štruktúrovanie a vysvetľovanie svojho kódu. Jednořádkové komentáre slúžia na krátke poznámky, zatiaľ čo blokové komentáre sú vhodné na dlhšie vysvetlenia. Dokumentačné komentáre sú naopak rozsiahle a ponúkajú hodnotu nad rámec zdrojového kódu.

Čo sú Java komentáre?

Práca so zdrojovým kódom môže niekedy predstavovať problém aj pre skúsených vývojárov. V závislosti od projektu a jeho rozsahu sa situácia môže rýchlo stať nepredvídateľnou a kód môže byť mätúci. V takýchto prípadoch možno nebudete chcieť pracovať na kóde sami. Ale aj keď chcete, aby mali ostatní prístup k vášmu kódu, nemusia ho intuitívne pochopiť.

Aby sa predišlo nedorozumeniam a aby bol kód prehľadnejší, Java umožňuje používateľom písať komentáre. Komentáre v tomto programovacom jazyku môžete použiť na vysvetlenie svojho myšlienkového procesu, výpočtov, metód, tried alebo štruktúr. Keď sa neskôr vy alebo niekto iný pozriete na kód, komentáre vám uľahčia prácu s kódom.

Aby boli komentáre účinné, je dôležité, aby boli čo najkratšie. Zároveň by mali poskytovať čitateľom dostatočné informácie. Pri riešení problémov sú dobre formulované komentáre nevyhnutné.

Komentáre v jazyku Java sú k dispozícii v troch rôznych verziách: jednoriadkové komentáre, blokové komentáre (viacriadkové komentáre) a dokumentačné komentáre. Všetky komentáre sú označené, aby sa pri kompilácii nezohľadňovali. V nasledujúcich častiach vám ukážeme, ako vytvárať komentáre v jazyku Java a kedy ktoré z nich používať.

Aké typy komentárov existujú v Jave?

V závislosti od druhu informácií, ktoré chcete napísať, sú v Jave k dispozícii tri rôzne druhy komentárov. Sú to:

Jednořádkové komentáre

Toto je najjednoduchšia možnosť komentára. Tento typ komentára sa vytvára pomocou dvoch po sebe idúcich lomítok (//) a nemôže byť dlhší ako jeden riadok. Pri jednoriadkových komentároch nie je potrebné označiť koniec, pretože sa automaticky dosiahne na konci riadku. Tento typ komentárov v jazyku Java je vhodný pre krátke komentáre, ktoré vysvetľujú funkciu niekoľkými slovami.

Viacriadkové komentáre

Ak potrebujete trochu dlhšie vysvetlenia, môžete použiť viacriadkové komentáre. Teoreticky môžu mať ľubovoľnú dĺžku. Sú vhodné na vloženie alternatívnych riadkov kódu, ktoré sú vylúčené z kompilácie, alebo na podrobné vysvetlenia. Viacriadkové komentáre sa začínajú lomítkom a hviezdičkou (/*). Keď dosiahnete koniec komentára, stačí napísať hviezdičku a za ňou lomítko (*/). Text medzi úvodným lomítkom a záverečným lomítkom sa považuje za komentár a pri kompilácii kódu sa nezohľadňuje.

Komentáre k dokumentácii

Zatiaľ čo jednořádkové a viacriadkové komentáre je teoreticky možné vložiť kdekoľvek do zdrojového kódu, dokumentačné komentáre sa vždy umiestňujú priamo pred triedy alebo metódy, ktoré opisujú. Pomocou nástrojov sa tieto komentáre prečítajú a zhrnú do dokumentácie HTML. Používajú sa predovšetkým na vytváranie metadát pre autorov a určité typy parametrov. Sú označené symbolom @. Dokumentačné komentáre sa začínajú lomítkom a dvoma hviezdičkami (/**) a končia hviezdičkou a lomítkom (*/).

Jednořádkové komentáre

Aby sme pochopili, ako komentáre v Jave fungujú v praxi, pozrieme sa na niekoľko jednoduchých príkladov. Môžete ich vyskúšať sami a otestovať výstup. Jednořádkový komentár začína dvoma lomítkami a môže byť buď na samostatnom riadku, alebo umiestnený za súborom inštrukcií. **. Takto vyzerá komentár na samostatnom riadku:

// Example of a single-line comment
class Main {
	public static void main(String[] args) {
	// Here is the comment
	System.out.println("This is the text that will be output at the end.");
	}
}

Ak použijete príkaz Java System.out.println, zobrazí sa len veta „Toto je text, ktorý sa zobrazí na konci“. Dva komentáre sa zobrazia len v zdrojovom kóde.

Prípadne môžete komentár umiestniť priamo za príkaz:

// Example of a single-line comment
class Main {
public static void main(String[] args) {
System.out.println("This is the text that is output at the end."); // This is the comment.
	}
}

Umiestnenie komentára nemení výstup.

Viacriadkové komentáre

Ak chcete do kódu vložiť viacriadkový komentár, môžete ho vložiť pred alebo za pokyny v kóde. Viacriadkové komentáre sa vždy začínajú lomítkom a hviezdičkou. Tu je viacriadkový komentár pred pokynmi v kóde:

/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are under the comment.
This is the last line of this Java comment.
*/
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
	}
}

Výstup znie: „Toto je text, ktorý bude na konci zobrazený.“.

Tu je návod, ako vložiť komentár pod pokyny:

// Example of a multi-line comment below the instructions
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are above the comment.
This is the last line of this Java comment. */
	}
}

Výstup by mal byť rovnaký ako v predchádzajúcom príklade. Jednoradkový komentár v prvom riadku úryvku kódu sa tiež nezobrazí. Hviezdičku a lomítko môžete umiestniť priamo za komentár alebo použiť samostatný riadok.

Komentáre k dokumentácii

Komentáre v dokumentácii fungujú podobne ako blokové komentáre, ale začínajú lomítkom a dvoma hviezdičkami. To umožňuje dokumentačným nástrojom používať komentáre na vytváranie dokumentácie. V prípade potreby môžu obsahovať aj HTML tagy, ako napríklad <h1>, <p> alebo <strong>.

Javadoc, populárny nástroj, ktorý môžete použiť na čítanie komentárov v dokumentácii, používa aj ďalšie užitočné tagy. Tu sú niektoré z najdôležitejších: