This post originated from an RSS feed registered with .NET Buzz
by Peter G Provost.
Original Post: "Why" Instead of "How" and "What"
Feed Title: Peter Provost's Geek Noise
Feed URL: /error.aspx?aspxerrorpath=/Rss.aspx
Feed Description: Technology news, development articles, Microsoft .NET, and other stuff...
If we transfer this little story to programming, it reminds me about that I think
we should be asking ourselves "why?" when writing comments. If you also need to write
comments for "how" and "what", it might be a sure sign of smelly code and an indication
that you need to do some refactoring.
Ahhh... that makes me feel good. Nice and simple. Comments should say WHY you did
something. If you have to write WHAT or HOW, then you have a problem.