Sandcastle Help File Builder相信很多的园友用过,小弟我最近因为工作原因需要生成公司的一套SDK的帮助文档,因此找了一些资料,发现网上的资料很多,但是都不怎么完全,有些只是随便写了一些类,生成一个帮助文档。没有整体性,因此在这里将我的一些步骤贴出来,供大家讨论。Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcatle 项目,Sandcastle 本身是一个console的程序,为了方便使用,我们可以使用他的GUI版本:Sandcastle Help File Builder

首先 环境准备,我这里是要生成.CHM格式的文档,因此需要一些软件来生成,软件下载

1.首先安装htmlhelp.exe,然后安装Sandcastle.msi,最后解压SHFBGuidedInstallation_1930,安装SandcastleInstaller.exe,按照提示,一步一步安装完成。安装完成后

Sandcastle Help File Builder使用教程-冯金伟博客园
Sandcastle Help File Builder使用教程-冯金伟博客园
Sandcastle Help File Builder使用教程-冯金伟博客园
Sandcastle Help File Builder使用教程-冯金伟博客园Sandcastle Help File Builder使用教程-冯金伟博客园
2.现在基本环境已经搭建好了,下面是要生成的项目的设置了,找到你要生成的项目,右键属性–生成,在XML文档前面打钩
Sandcastle Help File Builder使用教程-冯金伟博客园
3.生成所有要生成的项目,注意生成的项目一般都应为dll类型,即类库。
4.打开Sandcastle Help File Builder点击菜单项  file–new project,新建一个项目,下面就是项目的详细的设置了。首先添加要生成文档的dll和xml注释文档,找到右上方文件源和引用,文件源是指你要生成的dll和xml注释文档,引用是指你的dll的依赖项,比如你的dll引用了第三方的.net组件,或者你的dll引用了一些c或者c++的文件,都需要添加到引用。我们这套组件引用了一些自己编写的c文件。因此需要添加到此处。
Sandcastle Help File Builder使用教程-冯金伟博客园
5.添加完文件后就是一些主要的详细的设置了。
Build项下:
BuildLogFile:日志的路径
CleanIntermediates:如果true,生成项目时,上个项目生成的文件会删除。
FrameworkVersion:.NET WORK 的版本。
HelpFileFormat:帮助文档的形式,HtmlHelp1是值.chm的格式文件,这里我们设置此格式。还有msdn的格式可以设置。
Comments项:
NamespaceSummaries:命名空间说明,点击进入后会弹出所有的项目,你可以给所有的项目加上说明
Sandcastle Help File Builder使用教程-冯金伟博客园
Help File项
Sandcastle Help File Builder使用教程-冯金伟博客园
Sandcastle Help File Builder使用教程-冯金伟博客园
Sandcastle Help File Builder使用教程-冯金伟博客园
结果:
Sandcastle Help File Builder使用教程-冯金伟博客园