4 ms·
in general with code, if it needs explaining with comments then its not written cleanly. sometimes there are confusing external considerations, like mathematica
by jheriko 11y ago
in general with code, if it needs explaining with comments then its not written cleanly. sometimes there are confusing external considerations, like mathematical algorithms or additional constraints - that is what comments are for imo, explaining things external to the code that are required to understand it.
comments like "does this" are telling you the name of the function that the following code should be in.
... so unless your scripts/configuration data are written in a very esoteric language or format i'm inclined to agree with your point very strongly.