The Lounge is rated PG. If you're about to post something you wouldn't want your
kid sister to read then don't post it. No flame wars, no abusive conduct, no programming
questions and please don't post ads.
A wealthy man was dying and he wanted to take his money with him.
He had only 3 friends in the entire world: Bubba, Lester, and Leroy.
He split his money 3 ways and gave them each a substantial sum in cash.
He instructed them to toss the cash into the grave as he was being buried.
The man up and died, the 3 friends showed up for the burial and tossed packages into the grave.
Later, at a bar the 3 friends got to confessing things.
"I feel terrible" said Bubba, "but I actually kept 1,000.00 of the cash to pay for new tires for my truck and I didn't throw in the whole amount".
"I feel pretty bad as well" said Lester, "I did even worse and kept out 5,000.00 to pay for my daughter's college".
"I'm ashamed of both of you" replied Leroy, "I threw in a check for the entire amount".
Lester and Leroy are brothers, with Lester being both older and far more successful than Leroy. Their father, Aloysius, died recently. Leroy, who worked for his dad on the farm in Alabama, phoned his brother to give him the bad news.
"I'm so sorry," said Lester, "but I'm buried in meetings and I'm presently in Japan on business. You give Dad the absolute best, and just send me the bill. I'll take care of it."
A month passed, and Lester got a bill in the mail for $100. He was quite surprised at the tiny amount, but promptly sent his poor younger brother a check. The next month, he received another bill for the same amount. He assumed at this point that his good-hearted but somewhat dense brother was trying to cut him some slack on the bill by letting him pay it in installments. He sent another check and said nothing, not wishing to hurt his brother's feelings. But this process continued for several more months and he finally felt compelled to say something about it. So he phoned his brother.
Lester: "Leroy, please don't be offended but why do I keep getting these bills each month for $100?"
Leroy: "Well, you said to get Dad the best and send you the bill, right?"
Lester: "Yes, I said that."
Leroy: "So, I rented him a tuxedo."
While I personally too prefer to read code, rather than comments (especially since the compiler checks my code but not my comments), I don't mind the occasional meaningful comment (although I am eager to delete comments when I spot them, provided the code they explain is self-describing). But stuff like the // parses the date in the post above, or } // code block ends here are IMO just a sign of sloppiness and lack of understanding of what comments are really for.
Yeah but that's an extreme case.... the other side of that is someone who assumes that all their code is readable and interpretable by other people. An engineer that I'm working with now is really bothered by the fact that someone used "fs" to stand for file something or another (can't remember exactly) but to those of us in telecommunications, that's usually used for sampling frequency.
In another words, your self-commenting code might not mean the same thing to someone else, so just be mindful of that.