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ý.