Aaargh, Part Six: One More Thing About Comments- May 5, 2004 Gripe 7: Use The Right Struct For The Job I meant to include this one in yesterday's gripe about comments, as this illustrates a time when I found a comment that should never have been there. The person who wrote the comment should have realized that the very fact that they needed to put a comment in indicated that the code needed to be rewritten. It slipped my mind at the time though, so here it is today. Here's a fragment of code I found in an unnamed Microsoft product once. The...http://blogs.msdn.com/ericlippert/archive/2004/05/05/126739.aspx Aargh, Part Five: Comment Rot- May 4, 2004 Gripe 6: Comment Rot If you've been reading my SimpleScript code you might have noticed that there are very few comments in my code. That's deliberate. Why do we have comments in the first place We have comments because sometimes the semantics of the code are not clear from the syntax. Remember, the syntax tells you what the code does, the semantics tell you why the developer wrote that code, what the purpose is. I try to write code so that the semantics...http://blogs.msdn.com/ericlippert/archive/2004/05/04/125893.aspx |