Archives | June 2008


5 Tips for Writing Good Comments

24 Jun 2008 |  Posted by Erik St. Martin |  1 Comment.
1
There are probably as many theories on proper commenting of your code as there are developers writing the code. What is worth noting? what is not? I think to much focus is wrapped up in rules that make writing good comments confusing to new and seasoned developers alike. I will go over a few simple rules I like to stand by. 1) Use XDoc comments wherever applicable. There are a number of tools out there that will make your life a lot easier when generating base documentation and HTML versions of your API documentation. They are quite useful. 2) Don't comment just to comment. Quantity is not better...