Sandcastle+SandcastleHelpFileBuilder生成说明文档

1  安装说明

　　(1). 安装HTML Help Workshop。

　　(2). 安装Sandcastle。

　　(3). 安装SandcastleHelpFileBuilder。

　　(4). 安装SandcastleHelpFileBuilder的Visual Studio插件(可选, SHFBVisualStudioPackage.vsix)。

　　(5). 添加环境变量：”SHFBROOT”，值为SandcastleHelpFileBuilder的安装路径，如” C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\”。

 

2  使用说明

1. 打开SandcastleHelpFileBuilder安装目录下的SandcastleBuilderGUI.exe
2. “File”菜单——“New Project”
3. 右击项目下的”Documentation Sources”——“Add Documentation Source…”,添加要生成文档的.dll和.xml文件。
4. 设置项目的属性，如HelpTitle，HtmlHelpName等。
5. 生成项目，“Documentation”菜单——“Buid Project”

 

　　如果安装了SandcastleHelpFileBuilder的Visual Studio插件，可在Visual Studio中新建Sandcastle Help File Builder Ptoject。

1. “文件”——“新建”——“项目”，
2. 在已安装模板中选择”Documentation”，再选择” Sandcastle Help File Builder Ptoject”。
3. 右击项目下的”Documentation Sources”——“Add Documentation Source”,添加要生成文档的.dll和.xml文件。
4. 设置项目的属性，如HelpTitle，HtmlHelpName等。
5. 使用Visual Studio插件它会在chm文件中生成Welcome和VersionHistory，如果不想要可以在ContentLayout.content中删除。
6. 生成项目。

3 相关参考资料

http://www.cnblogs.com/ASPNET2008/archive/2010/07/09/1774459.html