by ericrallen on 1/30/2025, 1:54:07 PM
by uberman on 1/30/2025, 1:43:42 PM
I loved this footnote:
"That’s right, I’m the first person to admit that I shouldn’t have written this newsletter to begin with."
by dapperdrake on 1/31/2025, 10:57:58 AM
Weeeeeeeeeeeeee
Ouiiiiiiiiiiiii
In my experience, most teams are not operating at a level of comment saturation where we can worry about this kind of thing.
It can be hard enough to get folks to accept that their code isn’t “self-documenting” and actually write some comments to help the person who inherits their code orient themselves.
Often the comment author and comment reader are the same person, but separated temporally by all the time that has passed since the code was last read, understood, and internalized, so the two may as well be entirely different people.
As a note, I’m usually hesitant to refer to a specific variable name in a comment because code changes and comments aren’t always kept up to date, so you might actually be introducing more confusion in the future when someone renames a variable and no one notices that the comment is out of sync.