V tomto výučbe sa dozviete o komentároch Java, o tom, prečo ich používame a ako ich správne používať.
V počítačovom programovaní sú komentáre časťou programu, ktorú kompilátory Java úplne ignorujú. Používajú sa hlavne na to, aby pomohli programátorom porozumieť kódu. Napríklad,
// declare and initialize two variables int a =1; int b = 3; // print the output System.out.println("This is output");
Tu sme použili nasledujúce komentáre,
- deklarovať a inicializovať dve premenné
- vytlačiť výstup
Typy komentárov v Jave
V prostredí Java existujú dva typy komentárov:
- jednoriadkový komentár
- viacriadkový komentár
Jednoriadkový komentár
Jednoriadkový komentár sa začína a končí v rovnakom riadku. Na napísanie jednoriadkového komentára môžeme použiť //
symbol. Napríklad,
// "Hello, World!" program example class Main ( public static void main(String() args) ( ( // prints "Hello, World!" System.out.println("Hello, World!"); ) )
Výstup :
Ahoj, svet!
Tu sme použili dva jednoriadkové komentáre:
- „Ahoj, svet!“ programový príklad
- vypíše "Hello World!"
Kompilátor Java ignoruje všetko od //
konca riadku. Preto je tiež známy ako komentár na konci riadku .
Viacriadkový komentár
Ak chceme písať komentáre do viacerých riadkov, môžeme použiť viacriadkový komentár. Na napísanie viacriadkových komentárov môžeme použiť symbol / *…. * /. Napríklad,
/* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ class HelloWorld ( public static void main(String() args) ( ( System.out.println("Hello, World!"); ) )
Výstup :
Ahoj, svet!
Tu sme použili viacriadkový komentár:
/* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */
Tento typ komentára je tiež známy ako tradičný komentár . V tomto type komentára kompilátor Java ignoruje všetko od /*
do */
.
Používajte Komentáre správnym spôsobom
Jedna vec, ktorú by ste mali vždy brať do úvahy, by komentáre nemali byť náhradou za spôsob vysvetlenia zle napísaného kódu v angličtine. Vždy by ste mali napísať dobre štruktúrovaný a dobre vysvetľujúci kód. A potom použite komentáre.
Niektorí sa domnievajú, že kód by mal byť samopopisný a komentáre by sa mali používať zriedka. Podľa môjho osobného názoru však nie je nič zlé na použití komentárov. Pomocou komentárov môžeme vysvetliť zložité algoritmy, regulárne výrazy alebo scenáre, pri ktorých musíme na riešenie problémov zvoliť jednu techniku z rôznych.
Poznámka : Vo väčšine prípadov vždy používajte komentáre, aby ste vysvetlili „ prečo “ a nie „ ako “, a je dobré ísť.