Komentujete své kódy? Jak pečlivě? V jakém jazyce?

baronPlenck
baronPlenck
Já moc ne, ale to proto, že nemusím s nikým nijak zásadně spolupracovat. Maximálně popíšu nějaký ten bitjuggling špíček, nebo erratum, které se snažím obejít. Komentuju většinou anglicky, protože je to stručnější a jednoznačnější. A vkládám si hyperlinky, resp. vůbec citace použité literatury - to následně ušetří hromadu listování a pokud kód předávám dál, tak i vysvětlování ( „A četls o chybě v TRNG modulu na straně téaté a tu AN00324, kde se o tom rozepisují? Ne? Ale vždyť do komentu jsem dal odkaz. Tak si to přečti a když tě napadne něco lepšího, než seedovat šumem z ADC, tak se určitě ozvi. Tschüß!“)
dromedar
dromedar
Ano, celkem pečlivě, anglicky.

Na jednu stranu jsem umírněným stoupencem pravidla, že kód by měl být pokud možno samodokumentující (dokumentace, byť v podobě komentářů přímo v kódu, má tendenci zastarávat mnohem rychleji než spustitelný kód) a potřeba komentářů je "code smell", který často ukazuje na potřebu extrahovat (vhodně pojmenovanou) třídu/metodu/...
(odkaz na titul - a nejspíš i konkrétní exemplář, který mě tím názorem infikoval: https://ipac.svkkl.cz/arl-kl/cs/detail-kl_us_cat-c301097-Refaktoring/)

Na druhou stranu je spousta věcí, které jsou pro budoucího čtenáře kódu důležité/užitečné a kódem samotným se vyjádřit nedají.

Na třetí stranu jsem písemně ukecaný dromedar, takže upustit od (rozumné míry) komentování kódu by mě asi i bolelo a namáhalo.
radim24
radim24
Bez komentářů si neumím život představit. To by ani nešlo programovat.