How to build help documentation using Sandcastle – XML comments
07-Feb-1414 Leave a comment
After building XML Comments / Documentation and viewing these in a browser it may be useful to create documentation. Microsoft no longer develop a tool, but a tool Sandcastle they initially developed has continued.
This is some of my experience:
In addition to the normal Sandcastle, I installed the Sandcastle Visual Studio integration package.
Sandcastle have large documentation, but I found the basic steps were:
- Open Visual Studio
- Add New Project > Documentation > Sandcastle Help File Builder Project
- Add Documentation Sources – Reference to the project you want to document
- Build the project
- To view your new help file
- Use Menu > View > View Help File
- Or Open the Folder Location and open the Help folder
- Find the file ContentLayout.content
- Change the title from [TODO]
- You may get a lot of warnings and lots of ‘Red’ ‘missing documentation’
- To suppress these use Properties > Missing Tags and uncheck warning
- Or to use it to find missing documentation, uncheck
- All seems good so far.
See also