Obsah

Komentáře

V Javě jsou tři druhy komentářů:

Dokumentační komentáře jsou určeny pro zpracování programem javadoc, který generuje dokumentaci ve formátu HTML. 
  /**
   * Hlavní třída programu.
   */
  public class Hlavni {
     public static void main( String[] args ) {
        /* vytiskne odpověď */
        System.out.println( 42 ); // odpověď je 42
     }
  }
Prostřednictvím komentářů vkládáme do zdrojového textu doplňující informace. Překladač komentáře přeskakuje, tudíž na běh programu nemají žádný vliv. Komentovat bychom měli např. význam proměnných, neobvyklé postupy a netradiční algoritmy.

Otázky a odpovědi

Student: Mistře, kolik mám psát do zdrojového textu komentářů? Je nutné komentovat každý příkaz a každou proměnnou?
Java guru: Komentovat každý příkaz je zbytečné. Komentáře piš tam, kde není význam zdrojového textu na první pohled zřejmý. Příkladem zcela zbytečného komentáře je: 
  // do x přiřadíme hodnotu 123
  x = 123;
Tento komentář nepřináší žádnou novou informaci, protože každý přece vidí, jakou hodnotu přiřazujeme do proměnné x. Častěji se komentují vyšší syntaktické celky, např. použité algoritmy. Příkladem užitečného komentáře je: 
  /*
   * Pro nalezení největšího společného dělitele
   * použijeme Euklidův algoritmus.
   */
Výjimkou při psaní komentářů jsou učebnice a výukové texty. Např. v této učebnici najdeš často komentáře i k jednoduchým příkazům. Mají za úkol přispět k pochopení zápisu, který může být pro čtenáře nový nebo ne zcela srozumitelný.