制作API离线chm帮助文件

当我们开发好一个通信库的时候，我们希望给这个通信库配备一个帮助文档，最好的方式，就是有一个离线的chm版本的API文档，

这样别人在使用的时候，就可以清楚看到命名空间、类的结构，同时也能看到每个方法和属性的结构。

刚好最近在制作通信库的API帮助文档，借此机会，跟大家介绍一下如何制作API文档。

1、首先要将制作的dll写好注释，在类库项目属性中，勾选XML文档文件，这样就会生成该dll对应的说明文档xml文件。

 

 

 

 

 

 

2、然后需要下载一个软件SHFB，下载地址在github上：https://github.com/EWSoftware/SHFB/releases

 

 

 

 

下载后文件是这个样子的

 

我们先安装这个

 

 一直下一步就可以。安装完成后如下

 

 

 

我们还需要一个工具：https://www.onlinedown.net/soft/33431.htm

 

 

 

 

 直接安装就可以，注意安装时可以更改文件路径，但是不用更改安装文件名称。否则可能出错。

 

好了下面开始打开

 

 

 

 

 

 

 

 稍等片刻，见证奇迹的时刻，就要到了

 

 

 

如果看到类似这个，就说明制作成功了，看一下

 

 

 

 

 

 

 

有个地方值得注意，当我们将所有的方法和类都添加注释后，我们生成的时候，可能还会有警告，

大致意思是命名空间并没有注释，命名空间的注释在代码里是添加不了的，

需要在Sandcastle Help File Builder GUI软件中添加，点击左侧导航栏的Summaries，

点击Edit Namespace Summaries，进入界面后，通过点击选择命名空间，

右击一下，就可以输入所选命名空间的注释说明，全部输入完成后，点击Close即可。