这篇教程详细介绍了如何制作API的离线CHM帮助文件。首先在类库项目中生成XML文档文件，接着下载并安装SHFB软件，通过其GUI进行项目设置，包括添加DLL和XML文件，配置文档生成类型、语言和版权信息。在生成过程中可能需要安装额外的插件解决错误。最后，完成所有步骤后，将生成包含命名空间注释的完整API帮助文档。
当我们开发好一个通信库的时候，我们希望给这个通信库配备一个帮助文档，最好的方式，就是有一个离线的chm版本的API文档，这样别人在使用的时候，就可以清楚看到命名空间、类的结构，同时也能看到每个方法和属性的结构。
刚好最近在制作xktComm通信库的API帮助文档，借此机会，跟大家介绍一下如何制作API文档。
1、首先要将制作的dll写好注释，在类库项目属性中，勾选XML文档文件，这样就会生成该dll对应的说明文档xml文件。
2、然后需要下载一个软件SHFB，下载地址在github上：
https://github.com/EWSoftware/SHFB/releases
选择最新版下载即可。
如果github访问不了，可以通过公众号【dotNet工控上位机】获取，回复关键词：API制作套装
获取到的SHFB软件目录如下所示：
最低0.47元/天 解锁文章
扫一扫
2209
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
