Geeks With Blogs
Jonathan Starr's Blog Thoughts on C#, Ajax, WCF, LINQ, Agile et al.

improve my => 'code' Add to Google

Jeff Atwood wrote an interesting post today about Coding Without Comments.

If you didn't catch it, he basically says that if a coder uses excellent naming conventions in his code, the code is eminently readable.  So the need for comments is obviated.

Partly true, I say.  But there are significant exceptions to consider.

If you have external customers using your code, public methods should have have lots of comments.  With summary tags filled so your customer know what the methods do.  And code and example tags to give them easy to follow examples to emulate, and so they get their money's worth from your code.

I will let you in on a secret.  I write my stored procedures with in the comments so that everyone knows how to use them AND how to know that they are working.  (See wasn't that comment helpful?)

Jonathan Posted on Friday, July 25, 2008 5:48 PM C# , Critique , Software Design , Software Development , Agile Development , Scrum | Back to top

Comments on this post: Coding With Comments

# re: Coding With Comments
Requesting Gravatar...
Do you have an example of one of these unit test comments?
Left by Jeffy on Sep 04, 2008 4:02 PM

Your comment:
 (will show your gravatar)

Copyright © Jonathan Starr | Powered by: