新阁教育-付工
当咱们开发好一个通讯库的时候，咱们但愿给这个通讯库配备一个帮助文档，最佳的方式，就是有一个离线的chm版本的API文档，这样他人在使用的时候，就能够清楚看到命名空间、类的结构，同时也能看到每一个办法以及属性的结构。文章源自微观生活（93wg.com）微观生活-https://93wg.com/19397.html
恰好最近在制作xktCo妹妹通讯库的API帮助文档，借此机会，跟大家介绍一下怎么制作API文档。文章源自微观生活（93wg.com）微观生活-https://93wg.com/19397.html
1、首先要将制作的dll写好注释，在类库项目属性中，勾选XML文档文件，这样就会生成该dll对应的说明文档xml文件。文章源自微观生活（93wg.com）微观生活-https://93wg.com/19397.html
2、然后需要下载一个软件SHFB，下载地址在github上：文章源自微观生活（93wg.com）微观生活-https://93wg.com/19397.html
https://github.com/EWSoftware/SHFB/releases文章源自微观生活（93wg.com）微观生活-https://93wg.com/19397.html
选择最新版下载便可。文章源自微观生活（93wg.com）微观生活-https://93wg.com/19397.html
如果github走访不了，可以通过文章源自微观生活（93wg.com）微观生活-https://93wg.com/19397.html
3、打开InstallResources文件夹，找到SandcastleHelpFileBuilder.msi，双击安装，安装进程很简单，一路Next便可。文章源自微观生活（93wg.com）微观生活-https://93wg.com/19397.html
4、安装完成后，在跳到InstallResources文件夹同级目录，找到SandcastleInstaller.exe，双击安装。文章源自微观生活（93wg.com）微观生活-https://93wg.com/19397.html
5、安装进程会弹出两次下图的提醒框，点击是，继续到下一步。文章源自微观生活（93wg.com）微观生活-https://93wg.com/19397.html
6、安装完成后，在开始菜单中的最近添加中，找到Sandcastle Help File Builder GUI，点击打开。
7、打开以后，如果呈现下面的过错提醒，说明需要安装一个插件——BuildTools，获取方式，在前面获取的API制作套装中，有一个名称为BuildTools_Full.exe的程序，双击安装，如果没有过错，这一步跳过便可。
8、胜利打开后，新建一个项目，名称自己定义，添加第一步中筹备好的dll及其对应的xml文档。
9、然后通过左边的向导进行一些相关的设置，首先是Build页面，主要设置文档生成类型、语言及框架版本。
10、切换到第二栏Help File，设置相关的Title、版本号及相关版权信息。
11、点击Documentation下的Build Project按钮，生成项目。
12、如果呈现下图过错，过错代码BE0037，需要安装一个插件——htmlhelp，对应的安装包已经放到API制作套装中，获取方式，
13、安装完成后，从新Build Project，如果依然呈现过错，过错代码BE0065，需要再安装一个插件——vs_buildtools，对应的安装包已经放到API制作套装中，获取方式，
14、不出意外的话，应当可以生成，生成结果如下：
15、这样咱们就生成为了一个API的帮助文档，咱们可以对比Log，看看有哪些正告，由于可能有一些处所咱们的注释其实不完全。
16、有个处所值得注意，当咱们将所有的办法以及类都添加注释后，咱们生成的时候，可能还会有正告，大致意思是命名空间并无注释，命名空间的注释在代码里是添加不了的，需要在
Sandcastle Help File Builder GUI软件中添加，点击左边导航栏的Su妹妹aries，点击Edit Namespace Su妹妹aries，进入界面后，通过点击选择命名空间，右击一下，就能够输入所选命名空间的注释说明，全体输入完成后，点击Close便可。
16、下面是终究生成的chm帮助文档。【图片有误，后台答复API，查看完全版】
以上就是微观生活（93wg.com）关于“制作API离线chm帮助文件教程”的详细内容，希望对大家有所帮助！
评论