Sandcastle创建帮助文档

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

4．准备工作到此结束，下面就可以开始生成我们需要的帮助文档了。

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

    在C#项目中鼠标右键点击所选的项目，在显示的菜单中选择Properties选项，打开Properties Page，鼠标左键点击Build项，在显示的页面中勾选XML documentation file。

        C#项目设置完毕，再次运行该项目，就可以生成属于它的XML文件了。

      

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

      ★点击Add按钮，选中项目生成的exe,dll,xml文件

 

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

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

 

      ★设置HtmlHelp1xCompilerPath为HTML Help Workshop的安装路径，设置SandcastlePath为Sandcastle的安装路径

      ★最后点击顶头菜单Documentation下拉菜单中的Build Project选项（或直接使用快捷键Ctrl+Shift+B）即可生成所需的帮助文档，该文档的默认输出路径在项目所在目录的Help文件夹下，当然也可以更改Sandcastle Help File Builder中的设置，自己设定它的输入路径。

经过以上步骤，您就可以成功的为您的项目生成帮助文档了。

转载自：http://blog.sina.com.cn/u/4b756451010006n4