Coding With Comments

Coding With Comments: improve my => 'code'

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 unit tests 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 Print

Comments

# re: Coding With Comments: Jeffy; 9/4/2008 4:02 PM; Do you have an example of one of these unit test comments?

Post Comment

Please add 5 and 1 and type the answer here:

Enter the code shown above:

Archives

Post Categories

Image Galleries

About the Author

Blogs

GeeksWithBlogs

Geometry

Music

Programming

Storage

Videos

News: Jonathan Starr is a developer in Saint Louis, MO. He holds an MBA in Finance from Columbia Business School and earned his MCSD from Microsoft.

All statements in this blog are personal opinions and do not reflect the opinions of his employer.

Related Sites

Jonathan Starr's Blog