Sandcastle Help File Builder (SHFB) 项目推荐

Sandcastle Help File Builder (SHFB) 项目推荐

SHFB Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools. SHFB 项目地址: https://gitcode.com/gh_mirrors/sh/SHFB

项目基础介绍和主要编程语言

Sandcastle Help File Builder (SHFB) 是一个用于生成帮助文件的开源项目,主要用于为 .NET 类库生成文档。该项目的主要编程语言包括 C#、Visual Basic .NET、JavaScript、HTML 和 CSS。SHFB 提供了一个图形用户界面(GUI)、Visual Studio 集成包以及 MSBuild 任务,使得用户可以方便地配置和扩展帮助文件的生成过程。

项目核心功能

SHFB 的核心功能包括:

  1. 帮助文件生成:SHFB 能够从 .NET 类库的 XML 注释和反射信息中生成 API 参考文档。同时,它还支持生成概念性文档,这些文档可以通过 Microsoft Assistance Markup Language (MAML) 编写。

  2. 自动化构建:SHFB 提供了命令行工具和 MSBuild 任务,使得用户可以在自动化构建过程中集成帮助文件的生成。

  3. Visual Studio 集成:SHFB 提供了一个 Visual Studio 集成包,允许用户在 Visual Studio 中直接创建和管理帮助项目,简化了文档生成的流程。

  4. 扩展性:SHFB 允许用户通过插件和自定义模板来扩展其功能,满足不同项目的需求。

项目最近更新的功能

根据最新的更新记录,SHFB 最近更新的功能包括:

  1. 版本 2024.9.12.0:最新版本于 2024 年 9 月 12 日发布,包含了对最新 .NET 框架的支持和一些性能优化。

  2. 新增插件支持:增加了对更多插件的支持,使得用户可以更灵活地扩展 SHFB 的功能。

  3. 文档生成优化:改进了文档生成的算法,提高了生成速度和文档质量。

  4. Bug 修复:修复了之前版本中的一些已知问题,提升了项目的稳定性和用户体验。

通过这些更新,SHFB 继续保持其在 .NET 文档生成领域的领先地位,为用户提供了一个强大且易于使用的工具。

SHFB Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools. SHFB 项目地址: https://gitcode.com/gh_mirrors/sh/SHFB

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

实现步骤: 第一:把生成帮助的工程的属性做下修改,右键工程,属性,生成,下面的输出框中有一个生成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
发出的红包

打赏作者

喻建涛

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值