Re:Remove Half of Your Documentation
by ReleaseCandidat on Friday October 13, 2023 @08:44AM
(#37869953)
Oh, I'm not talking about comments, but literally road signs.
I've seen plenty of these comments myself in various states of correct- and usefulness (from right and helpful to redundant to wrong, because of a change to always been wrong) in the last (almost) 20 years. Some of them had been my own.
There's a thing that happens when you start coding, you put comments next to the sharp corners to remind you what it does (because your code is obscure and non-obvious, you've just started doing this), then you want it to look tidy and professional, and occasional comments look unbalanced, asymmetric, so you add comments on the obvious bits to give a nice uniform look to it. You end up with
I'm as guilty of this as everyone else. The OP is saying try to avoid that, comments have a maintenance cost.