Skip to main content
Dev Corner > Blogs > Dev Corner Blog > Posts > Forcing Documentation

e.magination Dev Corner Blog

Forcing Documentation

After my last post, I had a discussion with Steve Michelotti about documentation. Steve informed me that:

There is a way to get the build to break if proper documentation is not put into the code (in fact, this is what I did at Ad.com because I wanted developers documenting their code). First you turn on the XML Comments file in the project's properties. This will cause a compile warning if a public method does not have a comment. Then you turn on the switch to "Treat Warnings as Errors" and your build will break if the public method doesn't have a comment. Treating errors as warning is a strict switch but I think it's generally good practice *any way* because you don't want code littered with other things like unused local variables, etc. The documentation check is extra gravy.

Keep this in mind when setting up any new projects.

 
Forcing Documentation - Dev Corner Blog
Go Search
Other Blogs
There are no items in this list.