使用 Sandcastle Help File Builder 制作 VS.NET 的 HELP 文件

本文介绍了如何使用SandcastleHelpFileBuilder工具替代NDoc,以更简便的方式生成Visual Studio .NET的HELP文件。文章详细说明了安装步骤及操作流程,旨在帮助开发者简化文档创建过程。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

from:http://hi.baidu.com/jane200590296/blog/item/30c43289619bdebe0f244486.html
以前笔者都是使用 NDoc 在制作 VS.NET 的 HELP 文件,它是相当好用且速度快的 HELP 产生器;不过 NDoc 在 1.3.1 版后,NDoc 的作者 Kevin Downs 就不再进行 NDoc Open Soruce 的开发。笔者之前有自行修改 NDoc 的 Source Code 解决中文乱码的问题,不过后来又遇到泛型类别无法正常产生 HELP 文件的问题,所以就改用微软推出的 SandCastle 配合 Sandcastle Help File Builder 来产生 HELP 文件,本文将介绍使用 Sandcastle Help File Builder 制作 VS.NET 的 HELP 文件。

 

一、安装Sandcastle

首先安装微软的 Sandcastle - Documentation Compiler for Managed Class Libraries,你可以由下列网址下载最新版的 Sandcastle 安装程序,目前提供最新的版本为 Sandcastle May 2008 Release (Version 2.4.10520)。

http://www.codeplex.com/Sandcastle

 

二、安装Sandcastle Help File Builder

Sandcastle 本身可以使用命令列的方式来制作 HELP 文件,不过这样太麻烦了,所以就需就有了一些具 UI 界面的 Sandcastle 编译工具,例如 SandcastleGUIDocProjectSandcastle Help File Builder 等工具,我们选择 Sandcastle Help File Builder 来制作 HELP 文件,它的操作界面与 NDoc 几乎一模一样。你可以由下列网址下载最新版的 Sandcastle 安装程序,目前提供最新的版本为 1.7.0.0。

http://www.codeplex.com/SHFB

转载于:https://www.cnblogs.com/luoyaoquan/archive/2012/04/17/2454085.html

实现步骤: 第一:把生成帮助的工程的属性做下修改,右键工程,属性,生成,下面的输出框中有一个生成XML文件选项,打勾。文件会把工程中所有类,方法,属性上的注释保存下来。 第二:启动shfb,然后新建一个工程,名称可以随意指定。这里主要说说几个比较重要的属性设置问题: 1:Documentation Sources,是需要生成详细注释的工程。如果最外层工程有对其它工程的引用,而且我们希望看到所有引用的类,就需要把所有被引用的工程都添加进来。否则用户点击外层类时,被引用的类上面不会有链接,即我们看不到被引用类的内容。 2:References:设置一些工程的依赖项。 3:FrameworkVersion: 选择对应的Framework版本 ,最新版的shfb的默认设置是.net 3.5。 4:HelpFileFormat : 选择需要生成的文档的格式. 这里选定的格式要在下面对应的地方进行设置。对于不同的格式还需要安装不同的编译工具 Helpe1x(chm)需要安装Microsoft HTML Help,Helper2x(Hxs)需要安装 Hxcomp. 5:NamespaceSummaries: 选择需要生成的命名空间,直接点击开窗选择。 6:Lanugages :语言,如果文档中有中文,最好选择中文。 7:CopyrightHref:版权链接,例如http://www.xxx.com/ 8:CopyrightText: 版权文字 ,xx公司所有 9:HelpTitle: 文档标题 10:HtmlHelpName:文档生成文件名称 11:PresentationStyle: 支持vs 2005,Prototype等格式 ,根据自己需要选择 12: OutputPath:生成路径,即最后chm文件存放位置,当然除了CHM还有些其它文件。 13:HtmlHelp1xCompilerPath:可以自定义html help的安装路径。 14:SandcastlePath:可以自定义sandcastel的安装路径。 到此,我们就可以点击软件窗口上的buile the help file按钮,就可以按预期进行生成文档了。如果没有特殊情况,运行期间不会发生任何错误,我们会成功的在输出目录中发现chm文件,但有些情况还是需要注意一下的: 第一:在添加Documentation Sources时,不能在路径中包含.h的字样,例如.Hotel.Host\bin这种路径是不合法的,最后hhc软件会报错。 第二:References项中不能存在重复项。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值