如何制作dll库的API文档,自动生成微软风格的chm文件 Sandcastle Help File Builder 使用方法
当你开发了一个库的时候,就需要给库开发一个api文档,微软提供了一个C#库的自动生成工具。我在使用的过程中记录了相关的信息,以供大家学习和查阅,如有不正之处,欢迎指出。
首先先下载一个软件,下载地址在github上:https://github.com/EWSoftware/SHFB/releases
下载最新的版本即可。到本地后开始安装
先安装上面的msi文件,安装好以后,点击下面的文件
现在还是打开不了的,还需要下载个东西
这里有个提示很重要:意思是如果想使用单独的GUI程序,需要安装Microsoft Build Tools 2015,如果你想仅仅使用visual studio,那么这部分是可以忽略的。
点击下载安装这个即可。
然后打开:这时候是不会报错了。
然后点击创建项目,项目的目录最好位于dll项目下,然后关联dll,就可以点击build了
效果如下: