10 Feb 2010

how to simplify Sand Castle

Perhaps I am stupid, but I never wanted to understand the reason why VS does not generate SIMPLY chm and html file from XML comments....
anyway after 10 version of VS to produce a nice documentation of our class library we need to:

1) choose to build xml comments when we build

2) install SandCastle (and if you have time to loose, you can spend it to understand how to configure it, and how to customize your documentation)

3) download Sand Castle Help File builder from http://www.codeplex.com/SHFB

4) set a few parameters and you will have a nice documentation for your project.

No comments:

Post a Comment