Next: Řádky delší než 80
Up: Stylistické chyby
Previous: Nepřehledné nebo neúsporné odsazování
  Obsah
Komentář slouží k rychlejší navigaci a snazšímu pochopení zdrojového textu. Je
zbytečné komentovat každý řádek kódu - to se hodí jenom pro popis velmi
složitých a z hlediska řešení klíčových algoritmů. Zato je důležité komentovat
každý podprogram. Před každou hlavičkou procedury nebo funkce by měl být
komentář, který stručně vysvětlí co podprogram dělá. Dále je zde dobré popsat
parametry, které podprogram používá.
Komentáře jsou důležité pro osoby, které se snaží pochopit váš kód. Ale jsou
stejně důležité i pro vás. Jen velmi mizivé procento populace má absolutní
paměť. Každý normální člověk už po dvou měsících spolehlivě zapomene, jak
vlastně ten jeho program funguje. Po jisté době se třeba rozhodnete, že svůj
program rozšíříte. Ale jelikož jste jej nedostatečně okomentovali, už se v něm
nevyznáte. V některých případech je potom rychlejší napsat celý program znovu,
než se snažit pochopit starý nekomentovaný kód.
David Martinek
2002-10-01