Integrating sandcastle into build process to generate MSDN style documentation

A well documented code is always a good thing especially when it comes to maintaining it. I’d like to remind you guys a quote from Rick Osborne

“Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live.”

In this article I will walk through how to integrate Sandcastle tool to generate MSDN style documentation for your code. Before we look at how to get sandcastle tool integrated into your build process, I’d like to remind couple of things.

If you are not adding XML documentation to your code, start getting into that habit , all public methods/properties and classes should have XML documentation. For more information on recommended tags please read http://msdn.microsoft.com/en-us/library/5ast78ax(v=VS.100).aspx
You should turn on XML documentation for all your source projects, you can do this by going into project properties and selecting the build option as shown in the picture below

Read more: Ram's Blog

Posted via email from .NET Info