Programování bez komentářů

cs v kategorii code • 2 min. čtení
Mind the age! Most likely, its content is outdated. Especially if it’s technical.

Hodně vídám v kódu komentáře. To by nebylo to nejhorší, jsou situace, kdy jsou komentáře opravdu důležité, ale většinou narážím na situace, kdy je tomu opačně. Takové komentáře mám čím dál více nerad.

Přitom by stačilo málo – než se napíše komentář, stačilo by se zamyslet, zda je opravdu důležitý. Jako nejběžnější zbytečné komentáře jsou totiž takové komentáře, které popisují to, co už popisuje sám kód.

Pokud však kód nemluví sám za sebe (a zdá se, že je komentář nutný), pak je pravděpodobně samotný kód napsán špatně. Stačí se podívat zda nepomůže lepší pojmenování nebo rozdělení funkcionality na menší dílky atp. Prostě refaktorovat.

Ve výsledku by měl být komentář nutný opravdu jen ve výjimečných situacích.

Je mi jasné, že psát bez komentářů není jednoduché, chce to praxi. Jenže bez zkoušení se praxe nezíská. Hezky to popisuje Steve Yegge:

In the old days, seeing too much code at once quite frankly exceeded my complexity threshold, and when I had to work with it I’d typically try to rewrite it or at least comment it heavily. Today, however, I just slog through it without complaining (much). When I have a specific goal in mind and a complicated piece of code to write, I spend my time making it happen rather than telling myself stories about it.

S tím se vlastně pojí čistý kód. Doporučuju si přečíst knížku Clean Code nebo jsem o tom také psal na Zdrojáku v krátkém seriálu, kde se dozvíte jak psát kód, který mluví sám za sebe.

Naivně jsem měl za to, že komentáře budou ubývat a ubývat, ale opak je pravdou. Proto tento blogpost. Zahrajme si hru programujeme bez komentářů!



Sdílejte:   Facebook   Twitter   Reddit   Tumblr   Pinterest




Může se vám také líbit

en What Makes Good Program?, November 20, 2018
en Old Code, October 31, 2018
en Fast JSON Schema for Python, October 1, 2018
en Open Source Responsibilities, September 6, 2018
en Deployment of Python Apps, August 15, 2018


Populární v kategorii code

en Makefile with Python, November 6, 2017
en Deployment of Python Apps, August 15, 2018
cs Jasně, umím Git…, August 6, 2014
cs Checklist na zabezpečení webových aplikací, March 1, 2016
cs Pokročilé regulární výrazy, August 17, 2014