(1) 安装 Sandcastle.(安装文件下载地址:http://sandcastle.codeplex.com/releases/view/47665)
(2) 准备好需要生成文档的DLL文件和XML注释文件。
(3) 运行SandcastleGui.exe程序。(默认的文件路径是 C:\Program Files (x86)\Sandcastle\Examples\Generic)
(4) 从上至下依次添加DLL文件、XML注释文件、依赖DLL文件(可选项。如果被生成文档的DLL有引用则添加;反之,则不添加)。
添加完成后,在右上角填写生成文件的名称。
![]()
(5) 安装 HTML Help Workshop.exe 程序。HTML Help Workshop的安装文件下载地址是
http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en 。
默认的文件安装路径是:C:\Program Files (x86)\HTML Help Workshop
(6) 运行HTML Help Workshop.exe 程序。单击File菜单,选择Compile。
在弹出的窗体中选择前面使用Sandcastle生成的文件 .hhp文件,单击确定按钮。
![]()
(7) 如果生成成功,会在 C:\Program Files (x86)\Sandcastle\Examples\1111\vs2005\chm 目录下增加一个新文件 *.chm
*.chm文件就是最终的文档。
文档生成工具Sandcastle的使用
最新推荐文章于 2024-05-12 09:46:00 发布