The idea of having good comments in code has come up almost daily in my coding adventure. But I’m here to tell you a truth, all of us who were talking about good comments have yet to write consistently good comments! Let’s examine what makes a comment good.
I stumbled across this article by Andreas Klinger on the idea of good comments. The article’s title says it all! Good comments explain WHY, not WHAT, and 3 more rules on writing good comments.
It’s a simple idea, code should explain WHAT is happening while comments should explain WHY the code is happening. It’s a good read! Here’s to actually practicing what I’m preaching…
