Struktura programátorského kódu podle CleanCode? Nepoužívejte komentáře!
Komentáře v kódu
Obecně platí, že v případě Clean Code, byste se měli komentářům vyhýbat, asi jako koza farmářovu noži. Jsou tam výjimky. Ale většina komentářů je naprosto zbytečných, protože obsahují redundantní resp. nadbytečné informace.
Jak to myslím? Namísto toho, abyste pojmenovali nějakou proměnnou například. ps a v kódu vysvětlovali, že jde o podstránku, je lepší danou proměnnou již od začátku lépe pojmenovat podstranka.
Obecně platí, že pokud použijete dobré smysluplné a adekvátní názvy proměnných, funkcí, a tříd, pak nepotřebujete žádné komentáře, které dodatečně vysvětlují daný kód. A co víc, platí takové pravidlo, že dokonce kód s komentáři spíše vede k menší (tedy těžší) čitelnosti kódu.
Které komentáře jsou špatné?
Jak bychom mohli identifikovat špatné komentáře? Jsou to takové, které obsahují buď nadbytečné – přímo až zbytečné informace.
Stejně špatné komentáře jsou ty, které informují čtenáře o struktuře kódu. Platí, že pokud musíte (resp. máte nutkání) definovat hranice nebo bloky kódu přes komentáře, tak to znamená, že máte nepřehlednou strukturu kódu a komentáře to nezachrání. Např. pokud oddělujete/rozdělujete funkční bloky souboru na 2 - 3 části velkými komentáři, tak to velmi pravděpodobně znamená, že byste raději měli kód rozdělit na 2-3 soubory s oddělenou funkcionalitou.
Jak začít programovat?
Úvod do programování pro každého bez předchozích znalostí.
Stáhněte si náš ebook teď výjimečně zdarma!!!
Pokračovanie článku ako aj množstvo praktických ukážok nájdete v knižke.
Ako sa naučiť kultúru programovania CleanCode aj keď ste programátor začiatočník?
Na to vám poslúži CleanCode Bibka. Malá CleanCode Biblia, ktorú v pohode zlúskate behom víkendu. Stiahnite si náš ebook teraz zdarma:
Marián Knězek