利用Sandcastle快速生成一个源代码的帮助文档

1.安装Sandcastle(Version 2.6.1062.1)和SandcastleBuilder(SHFB v1.9.1.0 Release )

2.将源代码的项目，进行设置，"生成"—"XML文档文件"打钩
3.运行SandcastleBuilder安装出来的"Sandcastle Help File Builder GUI"。"Documentation Sources"右键点击"Add Documentation Source..."添加目标解决方案的sln
4."Sandcastle Help File Builder GUI"的"Project Properties"中"Paths"中"OutputPath"设置输出帮助文档的文件目录
5.点击"Documentation"菜单中的"Build Project"，SandcastleBuilder会自动生成出一个CHM文档，耗时较长。
注意：
1.注释的编写，参照：建议的文档注释标记（C# 编程指南）

2.项目一定要生成xml文档文件，虽然编译过程中会有未做注释的警告。

---

SandcastleBuilder常用设置：

Build

FrameworkVersion：设置sln的.net版本

Help File

HelpTitle:CHM文件的标题名

HtmlHelpName:CHM文件的文件名

Paths

OutputPath:CHM文件输出的目录