Sandcastle----强大的C#文档生成工具

Sandcastle是微软官方的文档生成工具，NDoc开发停止后，这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档，支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具，整个生成过程十分简单。

下面我来简单的介绍一下如何使用。

1.先下载最新的Sandcastle后安装.

2.然后下载 Sandcastle Help File Builder. 进行安装，根据提示将需要安装的插件全部安装成功，如果不知道可以选择默认，

3.安装完成后直接新建项目
新建项目，新建之后会看到一个 project Properties的菜单，这里我以 C#帮助文档为例，
选择 Help File 主要是红色区域的部分，选择之后在最右边部分，选择需要添加的 文件， 将dll文件和其对应的xml文件添加到项目中，右键add

4.点击上面的生成菜单或者按钮，就可以直接打开生成过程界面，在这里可以直接查看生成过程中的一些提示和错误.生成完成后，一个和MSDN风格一致的文档就出来了:

5.如果觉得系统生成的不好看，可以通过我的上一篇文章对chm帮助文档进行修改。

需注意：

1、在visio Studio中 相关文件 xml文档的生成。

在生成文档之前，需要说明一点，在VS.NET中，项目属性窗口里，要把“生成XML文档文件”的选项选中。

2、在需要生成的帮助文档代码中要写注释文档，要规范。

关于代码中注释的格式，就用VS.NET自己生成的格式就行（即，在函数定义前面输入///后IDE自动添加的注释格式），如下图。

更多复杂的设置，去官网的文档里查看吧。我就介绍到这里了。