四种Sandcastle方法生成c#.net帮助类帮助文档

转载

龙腾一族至尊龙骑 2022-08-18 02:04:06

阅读目录(Content)

方法一、Visual Studio新建documentation生成帮助文档
一、下载
二、安装
三、设置
五、生成
方法二、cmd生成帮助文档
方法三、SandcastleBuilderGUI
方法四、Sandcastle Help File Builder可视化工具

方法一、Visual Studio新建documentation生成帮助文档

前段时间在网上收集和自己平时工作总结整理了《干货,比较全面的c#.net公共帮助类》，整理完成上传github之后我又想，既然是帮助类，总得有个帮助文档于是乎想到了Sandcastle，Sandcastle是微软官方生成帮助文档这发面的工具。

它可以配合Microsoft Visual Studio生成的dll和xml注释文件生成完整的帮助文档。

结合可视化工具Sandcastle Help File Builder，简单直接，还能生成各种属性的说明。

支持Helpe1x:chm, Helper2x:Hxs, Website,HelperView等多种格式而且扩展灵活功能强大，下面我们就看一下怎样用Sandcastle生成chm文档。

首先我们前往CodePlex下载Sandcastle，地址:http://sandcastle.codeplex.com/

然后下载Sandcastle Help File Builder，地址：http://shfb.codeplex.com/，点击右边download下载即可。

二、安装

Sandcastle，直接Next就可以了，Sandcastle Help File Builder要说一下的是，在MAML Schema IntelliSense for Visual Studio为vs安装插件的时候一定要勾选上，不然新建项目的时候会没有这个选项。

四种Sandcastle方法生成c#.net帮助类帮助文档_xml

四种Sandcastle方法生成c#.net帮助类帮助文档_xml_02

四种Sandcastle方法生成c#.net帮助类帮助文档_xml_03

三、设置

四种Sandcastle方法生成c#.net帮助类帮助文档_html_04

在生成这里设置xml文档文件，保存，编译之后在你项目目录的bin\Debug就会看到生成的xml文件了。

四、新建项目documentation

四种Sandcastle方法生成c#.net帮助类帮助文档_html_05

首先新建documentation项目，这里就是安装Sandcastle Help File Builder的时候勾选上vs的原因。如果没有勾选上，这里新建的时候没有这个选项的。

四种Sandcastle方法生成c#.net帮助类帮助文档_帮助文档_06

四种Sandcastle方法生成c#.net帮助类帮助文档_xml_07

然后勾选上你刚才已经生成的dll和xml文件，右键属性如上图写上标题。编译生成即可。这里有一点要注意，可能会报错（SHFB: Error BE0037: Could not find the path the the HTML Help 1 compiler. See the error number topic in the help file for details.），是没有安装Microsoft HTML Help，当然你安装了之后可以跳过此步骤。

四种Sandcastle方法生成c#.net帮助类帮助文档_xml_08