Tuesday, November 18, 2008

Code documentation with SandCastle

1- Install sandcastle (latest release)
2- Sandcastle is command line driven. No GUI. Install this GUI tool to make life easy.
3- You must enable XML documentation file check box for each project. This will create an xml file along with each assembly.
4- Take each assembly and xml file drag and drop it into the tool.
5- Third party LIBS and assemblies that you do not have xml doc for can be excluded using BUILD/Dependencies section.
6- Use VISIBILITY/ApiFilter to cut down on what gets compiled into the help file. Otherwise it becomes too overwhelming
7- Doc for XML tags
Doc1
Doc2
Doc3