使用SandCastle生成API文档

1.安装

在http://www.codeplex.com/Sandcastle下载安装文件。

2. 程序安装好后，检查是否有环境变量”DXROOT”，该环境变量即为SandCastle的安装路径。

3. 使用SandCastle生成API文档。

(1) 假设我们有一个VS项目，生成一个程序集SharedDemo.dll;

(2)对该项目生成xml 注释文件；

项目属性 à Build à

 

(3) 将%DXROOT %/Examples/sandcastle/build_Sandcastle.bat复制到与SharedDemo.xml和SharedDemo.dll同一个目录下。

(4) 打开命令提示符，进到 SharedDemo.dll的目录下，运行下面的命令

build_Sandcastle.bat  vs2005  SharedDemo

注意,最后一个参数是”SharedDemo”而不是”SharedDemo.dll”

(5)在当前目录下，API文档被生成在chm文件夹内