1#

转自:http://www.cnblogs.com/netatomy/archive/2008/01/24/1050769.html

在上篇文章(编写并生成文档注释)中,我们已经了解了如何为类型和成员编写文档注释,以及如何生成相应的文档注释文件。在本文中,将简单地介绍如何使用 Sandcastle 生成 chm 文档。

Sandcastle 是一个文档生成工具,可以用它生成 MSDN 风格的文档,既能够生成 chm 文档,也能够生成 MS Help 2.x 帮助文档。在此之前曾流行的 NDoc,其作者已经放弃更新。

首先到 CodePlex 下载并安装 Sandcastle,目前最新版本是 Sandcastle January 2008 Release。安装后 Sandcastle 会创建一个系统环境变量 DXROOT,不要删除,因为 Sandcastle 要用这个环境变量。注意,如果之前安装过 Visual Studio 2005 SDK(安装它就意味着安装了早期版本的 Sandcastle),请删除用户环境变量 DXROOT,否则将影响新版本的使用。安装完成后,可以到安装目录下的 Examples 文件夹中看一看,这里有一些示例,可以用于研究 Sandcastle 的用法。

然后,准备好你的程序集和文档注释文件,我使用的是上篇文章中创建的 Hello.dll 和 Hello.xml。

接着,到 Sandcastle 安装目录下,把 Examples\sandcastle 文件夹下的 build_sandcastle.bat 文件复制到你的文件夹下,和 Hello.dll 以及 Hello.xml 放在一起。

最后,打开命令行,进入到这个目录,输入:build_sandcastle.bat vs2005 Hello chm <回车>。后面会出现很多信息,等这个批处理程序结束后,能看到多出了许多文件和文件夹。如果中间没有出现问题的话,进入 chm 文件夹,将会看到一个 Hello.chm 文件,这就是我们最终想要得到的——帮助文档,打开看一看吧,是不是挺漂亮的。下面是截图: