Komentáře Java: Proč a jak je používat?

V tomto kurzu se dozvíte o komentářích Java, proč je používáme a jak správně používat komentáře.

V počítačovém programování jsou komentáře částí programu, kterou kompilátoři Java zcela ignorují. Používají se hlavně k tomu, aby programátorům pomohli porozumět kódu. Například,

 // declare and initialize two variables int a =1; int b = 3; // print the output System.out.println("This is output"); 

Zde jsme použili následující komentáře,

  • deklarovat a inicializovat dvě proměnné
  • vytisknout výstup

Typy komentářů v Javě

V Javě existují dva typy komentářů:

  • jednořádkový komentář
  • víceřádkový komentář

Jednořádkový komentář

Jednořádkový komentář začíná a končí ve stejném řádku. K napsání jednořádkového komentáře můžeme použít //symbol. Například,

 // "Hello, World!" program example class Main ( public static void main(String() args) ( ( // prints "Hello, World!" System.out.println("Hello, World!"); ) ) 

Výstup :

 Ahoj světe! 

Zde jsme použili dva jednořádkové komentáře:

  • "Ahoj světe!" příklad programu
  • vypíše "Hello World!"

Kompilátor Java ignoruje vše od //konce řádku. Proto je také známý jako komentář na konci řádku .

Víceřádkový komentář

Když chceme psát komentáře do více řádků, můžeme použít víceřádkový komentář. K psaní víceřádkových komentářů můžeme použít symbol / *…. * /. Napří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 světe! 

Zde jsme použili víceřádkový komentář:

 /* This is an example of multi-line comment. * The program prints "Hello, World!" to the standard output. */ 

Tento typ komentáře se také označuje jako tradiční komentář . V tomto typu komentáře kompilátor Java ignoruje vše od /*do */.

Používejte komentáře správným způsobem

Jedna věc, kterou byste měli vždy vzít v úvahu, že komentáře by neměly nahrazovat způsob, jak vysvětlit špatně napsaný kód v angličtině. Vždy byste měli psát dobře strukturovaný a vysvětlující kód. A pak použijte komentáře.

Někteří věří, že kód by měl být popisný sám a komentáře by se měly používat jen zřídka. Podle mého osobního názoru však není nic špatného na používání komentářů. Můžeme použít komentáře k vysvětlení složitých algoritmů, regulárních výrazů nebo scénářů, kde musíme k řešení problémů zvolit jednu techniku ​​z různých technik.

Poznámka : Ve většině případů vždy používejte komentáře k vysvětlení „ proč “, nikoli „ jak “, a je dobré jít.

Zajímavé články...