Use sandcastle to create source code help document 3

1. Install sandcastle (version 2.6.20.2.1) and sandcastlebuilder (shfb v1.9.1.0 release)

2. Set the source code project to "generate"-"XML document file ".
3. Run the sandcastle Help File builder GUI installed by sandcastlebuilder ". "Documentation sources" right-click "add documentation source..." to add the SLN of the target Solution
4. In "Project Properties" of "sandcastle Help File builder Gui", "outputpath" in "paths" sets the file directory of the output help document
5. Click "build Project" in the "documentation" menu. sandcastlebuilder automatically generates a CHM document, which takes a long time.
Note:
1. For the compilation of comments, see the comments mark of the recommended documents (C # programming guide)

2. The project must generate an XML document file, although there will be no comments warning during compilation.

Sandcastlebuilder common settings:

Build

Frameworkversion: sets the. NET version of the SLN.

Help File

Helptitle: The title name of the CHM File

Htmlhelpname: name of the CHM File

Paths

Outputpath: Directory output by the CHM File