Štruktúra programátorského kódu podľa CleanCode? Nepoužívajte komentáre!

Komentáre v kóde

Všeobecne platí, že v prípade Clean Code, by ste sa mali komentárom vyhýbať, asi ako koza farmárovmu nožu. Sú tam výnimky. Ale väčšina komentárov je úplne zbytočných, pretože obsahujú redundantné resp. nadbytočné informácie.

Ako to myslím? No namiesto toho, aby ste pomenovali nejakú premennú napr. ps a v kóde vysvetľovali, že ide o podstránku, je lepšie danú premennú už od začiatku lepšie pomenovať podstranka.

Všeobecne platí, že pokiaľ použijete dobré zmysluplné a adekvátne názvy premenných, funkcií, a tried, tak potom nepotrebujete žiadne komentáre, ktoré dodatočne vysvetľujú daný kód. Ba čo viac, platí také pravidlo, že dokonca kód s komentármi skôr vedie k menšej (teda ťažšej) čitateľnosti kódu.

Ktoré komentáre sú zlé?

Ako by sme mohli identifikovať zlé komentáre? Sú to také, ktoré obsahujú buď nadbytočné –priam až zbytočné informácie.

Rovnako zlé komentáre sú tie, ktoré informujú čitateľa o štruktúre kódu. Platí, že pokiaľ musíte (resp. máte nutkanie) definovať hranice alebo bloky kódu cez komentáre, tak to znamená, že máte neprehľadnú štruktúru kódu a komentáre to nezachránia. Napr. pokiaľ oddeľujete / rozdeľujete funkčné bloky súboru na 2 - 3 časti veľkými komentármi, tak to veľmi pravdepodobne znamená, že by ste radšej mali kód rozdeliť na 2-3 súbory s oddelenou funkcionalitou.

Kurz UML - Základy jazyka UML v nástroji Enterprise Architect