utorok 6. novembra 2012

Programátori, používajte správne komentáre


Mnohí programátori sú úplne bezradní, keď sa majú rozhodnúť, aké komentáre zahrnúť do svojho kódu. A iný programátor je ešte bezradnejší, ak má tu smolu, že sa musí v takomto kóde orientovať.

Komentáre by ste mali pridať minimálne k funkciám, aby bolo jasné, načo slúžia. Opísať by ste mali minimálne všetko, čo programátor potrebuje vedieť v súvislosti so vstupnými parametrami jednotlivých funkcií. Časti kódu, ktoré nie sú triviálne (alebo samovysvetľujúce), by tiež mali byť doplnené komentármi.

Komentáre varujúce programátora o obmedzeniach jednotlivých parametrov sú často kritické. Toto treba zdôrazniť najmä v prípade programovacích jazykov, ktoré nie sú prísne typové, ako napríklad JavaScript alebo VBScript. V týchto jazykoch nemáte veľa možností, aby ste programátorovi zabránili v zadaní parametrov nesprávneho dátového typu.

Robustnosť kódu môžete zvýšiť aj tým, že vždy skontrolujete, či ste na vstupe dostali očakávané parametre. Avšak niekedy nemusí byť doplnková kontrola efektívna z pohľadu času venovanému samotnému naprogramovaniu a neskôr spracovaniu takéhoto kódu. Takže mnohokrát je najjednoduchšie napísať krátky komentár.