Sandcastle入门：创建C#帮助文档

核心提示： 1.首先要为项目生成一个包含注释的XML文件在c#项目中鼠标右键点击所选的项目，选择Properties->Build项，Sandcastle入门：创建C#帮助文档(4)，勾选XML documentation file，设置完毕编译项目，然后Start documenting，5）

1.首先要为项目生成一个包含注释的XML文件

在c#项目中鼠标右键点击所选的项目，选择Properties->Build项，勾选XML documentation file。设置完毕编译项目，就可以生成属于它的xml文件了。

2.打开我们已经安装好的Sandcastle Help File Builder并对它进行设置

>>点击Add按钮，选中项目生成的exe,dll,xml文件

>>保存该项目后点击Namespaces按钮，选中想要生成帮助文档的Namespace

>>设定Dependencies选项，把项目中所引用到的dll文件加载进去

>>设置HtmlHelp1xCompilerPath为HTML Help Workshop的安装路径，

>>设置SandcastlePath为Sandcastle的安装路径

3.点击顶头菜单Documentation下拉菜单中的Build Project选项

（或直接使用快捷键Ctrl+Shift+B）编译即可生成所需的帮助文档

4.该文档的默认输出路径在项目所在目录的Help文件夹下，当然也可以更改Sandcastle Help File Builder中的设置，自己设定它的输入路径。==========================================================================

5.2 SandcastleGUI

1）生成各项目的*.dll和*.xml文件（在vs2005中编译选项设置，具体前面5.1 Sandcastle Help File Builder的生成步骤中已提及）；

2）将*.dll和*.xml文件放在一个目录A下；将所有要附加的图片（比如类图和时序图）放在另一个并行的目录B下（注意不能有子文件夹）；

3）启动SandcastleGUI，设置：

Directory that contains assemblies to document项选择目录A；

Output directory项选择一个空文件夹，如C；

Directory to include in documentation项选择目录B；

其它如C#语法、是否包含C#例子、生成文档类型（website或chm）等选项根据需要填。

4）设置完成后最好Save settings，因为可能常常要用到。然后Start documenting。

5）等待生成完成后就可以在C目录下找到chm文件了：

5.3 Sandcastle CHM编译BAT脚本和配置实用工具

5.4 DocProject

参考文章：Ref[4]

——使用MSDN上包含有标准注释的XML文档生成帮助文件示例

==========================================================================

1 先编写一个类库，这里使用的是MSDN上包含有标准注释的"XML文档"示例

2 打开下载到的工程文件, 打开XMLsample.cs, 可以看到各种注释的详细解释

3.使用DocProject方式, 在确保安装了DocProject后, 为工程添加新项目

==>==>==>==>

4.编译DocProject前, 务必使你所要生成文档的类库编译输出注释的XML文件, 详细方法请查看在Visual Studio中生成“XML文档”示例

5.编译DocProject项目, 等待十几分钟(似乎有点慢, 即使类库很小), 就会在该项目下看到HTML版和CHM版的文档了。