首页 > 其他分享 >SHFB:为 .NET 类库快速生成说明文档

SHFB:为 .NET 类库快速生成说明文档

时间:2023-07-31 18:15:08浏览次数:35  
标签:类库 xml 项目 生成 文档 帮助文件 SHFB NET

SHFB 全称 Sandcastle Help File Builder ,项目地址:https://github.com/EWSoftware/SHFB。 它使用代码中的xml注释生成说明文档。因此,使用SHFB之前要给代码编写好xml注释。

安装

进入项目的 Github Release 页面:https://github.com/EWSoftware/SHFB/releases 下载最新发行版本,SHFBInstaller_2023.7.8.0.zip

下载完成后解压,里面有一个安装器,双击打开

img

根据提示,安装必需的组件即可,我只安装了这个一个组件:

img

然后按 Next 到最后一页,按右下角 Close 按钮即安装完成。

使用

打开安装文件夹,找到 SandcastleBuilderGUI.exe ,打开这个程序。

1.新建 SHFB 项目

左上角 File>New Project

img

SHFB项目文件的后缀为.shfbproj

2.选择 .NET 框架版本

img

3.在 Visual Studio 中生成 xml 文件

右键项目,打开项目属性,在生成>输出中勾选生成文档文件

img

然后生成一下项目,xml文件就一起生成了:

img

4.向 SHFB 项目添加源文件

这一步是把上一步生成的 dll 和 xml 文件添加到 SHFB 项目。右侧 Project Explorer>(项目名)>Documentation Sources,右键 Add Documentation Sources,选择源文件。找到生成的dll、xml文件,并添加。

img

5.项目属性

  • 帮助文件设置为中文
    img

设置为中文后生成的html文件格式有bug,我向项目提了 issue ,最新版已经修复。

  • 首页显示所有命名空间
    img

  • visibility 生成哪些成员的说明文档
    img

  • Missing Tags 生成的说明文档包含哪些xml注释标签。例如,c#代码注释里面没有写<returns>标签的值,就勾选掉这一项
    img

6.生成帮助文件(说明文档)

点击顶部Build按钮,构建帮助文件:

img

生成的帮助文件,在SHFB项目文件的同一级的Help文件夹内,我生成的是网页,所以,直接打开index.html,就是帮助文件。

随机展示一个页面:
img

标签:类库,xml,项目,生成,文档,帮助文件,SHFB,NET
From: https://www.cnblogs.com/sq800/p/17587032.html

相关文章

  • NET/C#中SM2/SM3国密加密算法
    usingOrg.BouncyCastle.Asn1;usingOrg.BouncyCastle.Asn1.GM;usingOrg.BouncyCastle.Asn1.X9;usingOrg.BouncyCastle.Crypto;usingOrg.BouncyCastle.Crypto.Parameters;usingOrg.BouncyCastle.Math;usingOrg.BouncyCastle.Security;usingOrg.BouncyCastle.Util......
  • 7.kubernetes存储卷、持久卷、pv和pvc、NFS CSI部署示例
    pod资源规范总结资源类型获取:kubectlaip-resources资源群组获取:kubectlaip-versions特定资源的规范获取:kubectlexplain<Kind>.pod运行自主式pod,非受控于工作负载型控制器直接由kubelet管理apiVersion:v1kind:Po......
  • 简简单单学docker在群晖nas中构建docker版aspnetcore网站
    琢磨了n天,掉了好多头发,终于可以了,踩坑无数!终于行了!先来了解下:1.net运行时runtime和sdk,简单来说就是sdk开发用的,runtime是用来运行的,所以构建dockerfile只用runtime就够了!2.docker运行不需要打包操作系统如ubuntu等进入包内!特殊需要的可以!这个问题都必须了解!正式开始1.用vs202......
  • ETHERNET/IP 转ETHERCAT连接倍福和欧姆龙PLC的配置方法
    ETHERNET/IP和ETHERCAT是两种不同的协议,它们在工业生产中都有广泛的应用。然而,由于协议不同,这两种设备之间无法通讯,这给工业生产带来了很大的麻烦。而捷米JM-EIP-ECAT网关应运而生,它能够连接到ETHERNET/IP总线和ETHERCAT总线中,实现两种不同协议设备之间的通讯。这个网关能够大大提......
  • 对 .NET 开发者来说,Azure AD 改名为 Microsoft Entra ID 意味着什么?
    对.NET开发者来说,AzureAD改名为MicrosoftEntraID意味着什么?原文地址:https://devblogs.microsoft.com/dotnet/azure-ad-microsoft-entra/你可能已经听说了这个重要的声明:《重新想象基于MicrosftEntra的私密访问》,AzureActiveDirectory(AAD)该名为MicrosoftEntr......
  • ETHERNET/IP 转ETHERCAT连接ethercat转换器
    捷米JM-EIP-ECAT网关连接到ETHERNET/IP总线中做为从站使用,连接到ETHERCAT总线中做为从站使用,可以同时满足多种工业生产的需求。支持广泛的设备类型,可以和多种不同的设备进行通讯。 技术参数ETHERNET/IP技术参数网关做为 ETHERNET/IP 网络的从站,可以连接 AB(罗克韦尔)、......
  • C#.NET 国密SM4对称加解密 与JAVA互通 ver:20230731
    C#.NET国密SM4对称加解密与JAVA互通ver:20230731 .NET环境:.NET6控制台程序(.netcore)。JAVA环境:JAVA8,带maven的JAVA控制台程序。 简要解析:1:加密的KEY、明文等输入参数都需要string转byte[],要约定好编码,如:UTF8。2:加密后的输出参数:byte[],在传输时需要转为stri......
  • 记一次 .NET 某物流API系统 CPU爆高分析
    一:背景1.讲故事前段时间有位朋友找到我,说他程序CPU直接被打满了,让我帮忙看下怎么回事,截图如下:看了下是两个相同的程序,既然被打满了那就抓一个dump看看到底咋回事。二:为什么会打满1.真的被打满了吗凡事都要用数据说话,我们使用!tp命令观察一下。0:014>!tplogStart:......
  • .Net设置SplashScreen,在高DPI下不居中的解决方案
    .Net设置SplashScreen,在高DPI下不居中的解决方案根据.Net官方文档,设置图片类型的软件的启动屏幕非常简单,只需要将图片放在工程里,并将图片的生成操作设置为SplashScreen后即可。但是这个办法在高DPI屏幕中没有适应,图片显示的位置不居中,对于强迫症来说会非常非常难受。查......
  • You must install or update .NET to run this application
    Youmustinstallorupdate.NETtorunthisapplication问题原因在使用.net的环境时,出现这个“Youmustinstallorupdate.NETtorunthisapplication”说明版本不符合系统默认式是2.0,3.0版本的,需要更新到5.0版本才行去官网下载符合自己的版本官网地址:https://do......