Jak používat komentáře v kódu Java

Komentáře Java jsou poznámky v souboru kódu Java, které jsou ignorovány kompilátorem a modulem runtime. Používají se k anotaci kódu, aby se vyjasnil jeho design a účel. Do souboru Java můžete přidat neomezený počet komentářů, ale při používání komentářů je třeba postupovat podle „osvědčených postupů“.

Obecně jsou komentáře k kódům "implementační" komentáře, které vysvětlují zdrojový kód, například popisy tříd, rozhraní, metod a polí. Obvykle se jedná o několik řádků napsaných nad nebo vedle kódu Java, které objasňují, co to dělá.

Dalším typem komentáře v jazyce Java je komentář Javadoc. Komentáře Javadoc se mírně liší v syntaxi od implementačních komentářů a jsou používány programem javadoc.exe ke generování Java HTML dokumentace.

Je dobré zvyknout si do zdrojového kódu vkládat komentáře Java, aby se zvýšila jeho srozumitelnost a srozumitelnost pro sebe a další programátory. Není vždy okamžitě jasné, co provádí část kódu Java. Několik vysvětlujících řádků může drasticky zkrátit dobu potřebnou k pochopení kódu.

Poznámky k implementaci v roce 2007 Java kód jsou tam jen lidé, aby si je mohli přečíst. Kompilátoři Java se o ně nestarají a kdy kompilace programu, prostě přes ně přeskočí. Počet komentářů ve zdrojovém kódu nebude ovlivněn velikost a účinnost kompilovaného programu.

Poznámky k implementaci přicházejí ve dvou různých formátech:

• Řádkové komentáře: Chcete-li zadat jeden řádek, zadejte „//“ a následujte dvě lomítka s vaším komentářem. Například:

   // Toto je jednorázový komentář
  int guessNumber = (int) (Math.random () * 10); 

  Když kompilátor narazí na dvě lomítka, ví, že vše, co je napravo od nich, je třeba považovat za komentář. To je užitečné při ladění části kódu. Stačí přidat komentář z řádku kódu, který ladíte, a kompilátor jej neuvidí:

  •  // Toto je jednorázový komentář
    // int guessNumber = (int) (Math.random () * 10); 

    Na konec řádku můžete také použít dvě lomítka:

  •  // Toto je jednorázový komentář
    int guessNumber = (int) (Math.random () * 10); // Konec řádku 

• Blokovat komentáře: Chcete-li začít blokovat komentář, zadejte "/ *". Všechno mezi lomítkem a hvězdičkou, i když je na jiném řádku, je považováno za komentář, dokud komentář nekončí znaky „* /“. Například:

   /* tento 
  je 
  A
  blok
  komentář
  */
  / * tak to je * /
  

K dokumentaci Java API použijte speciální komentáře Javadoc. Javadoc je nástroj zahrnutý do JDK, který generuje HTML dokumentaci z komentářů ve zdrojovém kódu.

Javadoc komentář v

.Jáva

/**

*/

*

Umístěte tyto komentáře přímo nad metodu, třídu, konstruktor nebo jakýkoli jiný prvek Java, který chcete dokumentovat. Například:

// myClass.java
/**
* Udělejte toto souhrnnou větu popisující vaši třídu.
* Tady je další řádek.
*/
veřejnosttřída moje třída
{
...
}

Javadoc obsahuje různé značky, které řídí, jak bude dokumentace generována. Například

@param

 / ** hlavní metoda
* @param args String []
*/​
veřejnoststatickýneplatný main (String [] args)
​{
System.out.println ("Hello World!");
}

Mnoho dalších značek je k dispozici v Javadocu a také podporuje HTML tagy, které pomáhají řídit výstup. Další podrobnosti naleznete v dokumentaci k Java.

• Nepřekračujte komentář. Každý řádek vašeho programu nemusí být vysvětlen. Pokud váš program probíhá logicky a nedochází k neočekávaným situacím, necítíte potřebu přidat komentář.
• Odsadit vaše komentáře. Pokud je řádek kódu, který komentujete, odsazen, ujistěte se, že se komentář shoduje s odsazením.
• Mějte komentáře relevantní. Někteří programátoři jsou výborní v úpravě kódu, ale z nějakého důvodu zapomenout aktualizovat komentáře. Pokud komentář již neplatí, upravte jej nebo odeberte.
• Nevkládejte komentáře bloku. Výsledkem bude chyba kompilátoru:

   /* tento 
  je
  / * Tento komentář bloku dokončí první komentář * /
  A
  blok
  komentář
  */