Je Vam dufam jasne ze tento problem je cisto dosledok Open Source, ze mate potrebu vsetko verejne zdielat. Robim v spolocnosti co vytvara vyhradne uzevrety system ktory ani nikdy v buducnosti neopusti spolocnost. Ani netusite co sa tu pouziva ako komentare a nazvy premennych. Podla mne je to dobre ze sa takto programator moze uvolnit a nemysliet korektnost, ktora ho v realnom zivote cim dalej tym viac obtazuje.
Leta jsem byl vychovavan s tim ze je nutno psat komentare. Pak se my do rukou dostala prednaska a tam bylo :" komentare se nepisou, kod musi byt samodokumentavatelny".
Malem jsem se prezehnal, takove kacirstvi.
Pak jsem videl takto napsany kod a musel jsem souhlasit.
No ale zivot je ruzny. Ja u komentaru zustal ale kod se snazim psat lepe.
...klasická odpověď jakou my starci dáme skoro na vše je: "to záleží".
Je sakra rozdíl mezi většinou škodlivým komentováním "jak" někde "uvnitř" a mezi tím připravit OpenAPI pro "vnějšek" nebo tím popsat architekturu v `ARCHITECTURE.md`.
Také záleží třebas na tom, co máš za prostředky jazyka - např. spoustu věcí, co bys musel někde komentovat, vyjádříš v jiných jazycích díky typům.
Všechno chce svou míru. Kód kde je dokumentovaná každá blbost časem skončí se spoustou zastaralých komentářů, na které nikdo nesáhl - protože nejsou součást kódu a nesrovnalost v komentáři prostě občas uteče i review.
Hlavní pointa samodokumentujícího kódu je pojmenovávat proměnné a funkce tak, aby nebyl komentář naprosto nutný k pochopení jejich účelu.
// Hymen, because I'm an incel who's knowledge of anatomy got stuck in middle ages
// True for the first pass of following loop
let hy = true;
vs
let first_pass = true;
Ta druhá varianta je dost jasná.
Řídím se pravidlem, že kromě veřejného API má být komentář jenom tam, kde kód nejde z vážných důvodů přepsat tak, aby komentář nepotřeboval.
Nejlepší na tom celém vláknu je, že mnozí si ten popisovaný „kratičký záchvat smíchu“ vykládají tak, že to všem připadalo vtipné. A zbytek přemýšlí, kolik z těch „záchvatů smíchu“ znamenalo „chudák malej, on asi opravdu neví…“