.NET2005文档自动生成

一、Sandcastle简介：

Sandcastle(CodeName)是微软出的用于编译发布组件（Assembly）信息的一个工具，其前身为发布VS2005之前，MS内部开发了一个用于生成帮助文档的工具。当前Sandcastle最新版本是June CTP，使用的方式仍然是命令行，而官方网站上给出的使用说明只能支持单一的dll，对于Solution仍然没有任何说明。

二、Sandcastle与NDoc的简单比较：

NDoc是.Net2003下的文档生成工具，它是一个开源的东东。目前已经停止开发，最新版本不支持2.0。

它们都是通过反射和Xslt技术，从dll文件及其注释（编译时加/doc参数得到）中得到一个完整的帮助文档，文档格式可以是html或chm甚至是任何自定义的格式。

当前Sandcastle最新版本是June CTP，使用的方式仍然是命令行，不提供GUI支持；而且官方网站上给出的使用说明：其只能支持单一的dll，对于Solution仍然没有任何说明。

三、如何利用Sandcastle自动生成.NET2.0开发帮助文档

A．软件安装准备工作：

1. 到以下网站下载Sandcastle(TCP)并安装。

http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en

2．到以下网站下载HTML Work Shop并安装，需要使用其中的hhc.exe文件。

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp

3．到以下网站下载Sandcastle Help File Builder 并安装，这是一个用Sandcastle生成帮助文档的GUI，省去了用户自己输入命令行的麻烦。

http://www.codeproject.com/useritems/SandcastleBuilder.asp

B．生成开发帮助文档：

1．首先要为项目生成一个XML文件

在C#项目中鼠标右键点击所选的项目，在显示的菜单中选择Properties选项，打开Properties Page，鼠标左键点击Build项，在显示的页面中勾选XML documentation file。 C#项目设置完毕，再次运行该项目，就可以生成属于它的XML文件了。    

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

3．点击Add按钮，选中项目生成的exe、dll、xml文件

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

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