使用 SHFB 生成 chm[C# 篇]

为了统计项目中后台的所有方法定义和注释，使用相对比较老的 SHFB(Sandcastle Help File Builder)来生成

已知目前 swagger 可以实现，此方法是用作学习整理，老项目是可以用到的

SHFB 的安装

下载地址-github 地址

[Releases · EWSoftware/SHFB (github.com)]

下载解压后的目录是这样的

双击 SandcastleInstaller.exe 打开安装界面

安装 SandcastleInstaller

首页打开后按 Next，直到 HTML Help 1 Compiler 需要注意下

HTML Help 1 Compiler

这一步很重要，会决定你是否可以生成 chm 文件

下载后，点击 htmlhelp.exe

一路 yes

到了这一步，默认路径就 ok，因为后面它自己会验证是否安装

安装成功

点击 search 后的页面

看到这个页面后，恭喜你安装成功，直接点击 next

SHFB Visual Studio Package

点击 Install Package，会提示你安装 vs 的组件，我本地安装了 vs2019 和 vs2022，所以会出现两个提示

和 vs 安装组件一样，正常安装即可，这里不多做赘述

项目打包成 chm

要生成的项目，右键属性=> 生成=> 输出=> 勾选 生成包含 API 文档的文件

然后重新生成你的项目

新建 SHFB 项目

点击下一步

创建

创建成功后的目录

右键创建好的 SHFB 项目=> 属性

Build

Presentation style 选择 VS2013

按照自己的需要去勾选，我目前只需要生成 chm 语言只要 C#的，所以我只勾选了这两个

Help File

1. Help title=> 每个页签上面的 Title
2. Help file name=> 生成的文件名称
3. Help file version => chm 的版本号
4. Help file language=> 按需选择语言，我选的是中文

点击保存

现在把需要生成 chm 的文件添加到 SHFB 项目中

Documentation Sources 右键 Add Documentation Source

选择之前项目生成的 dll 和 xml 文件，点击打开

打开后的目录如图

生成 SHFB 项目

生成成功的截图

右键 SHFB 项目=> 在文件资源管理器中打开文件夹，如下图

有一个 Help 的文件夹，点击进入 Help 文件夹内，可以看到自己刚才生成的 chm

打开 chm 文件后可以看到代码已经被打包成功

源码

点击下载源码