Re:Names should be cute, not descriptive
by IshKebab on Tuesday January 10, 2023 @01:53PM
(#34329609)
This is the sort of nonsense argument people use to justify not writing comments. "But the comment might get outdated!!"
Yes it might. But it probably won't, or it will be obviously outdated, or outdated in trivial ways or you can use Git blame to check how the code was when it was written. All of which is better than no comments 99% of the time.
The number of times I've read a comment and eventually thought "oh damn that was misleading, I wish that comment wasn't there" is like... 10 in my whole life.
The number of times I've thought "why does the foo-service also do bar? I wish they'd named it completely randomly instead" is precisely zero.
Yes it might. But it probably won't, or it will be obviously outdated, or outdated in trivial ways or you can use Git blame to check how the code was when it was written. All of which is better than no comments 99% of the time.
The number of times I've read a comment and eventually thought "oh damn that was misleading, I wish that comment wasn't there" is like... 10 in my whole life.
The number of times I've thought "why does the foo-service also do bar? I wish they'd named it completely randomly instead" is precisely zero.