下载: https://github.com/EWSoftware/SHFB/releases

使用Sandcastle生成Api文档需要使用对应程序集的注释xml + 程序集dll作为数据源，通过对xml + dll数据解析生成文档；所以主体步骤如下：

  • 程序集资源生成
  • 创建配置.shfbproj项目
  • 编译构建文档

程序集资源生成

生成程序集Api Xml

配置需要生成的程序集Api Xml，默认生成到\bin\Debug\xxx下

image-20230602092253720

输出文件

image-20230602092330398

创建配置.shfbproj项目

此处为使用 Sandcastle Help File Builder GUI进行项目的创建、配置；

当然，你也可以使用vs创建，前提是需要安装vs插件包：四种Sandcastle方法生成c#.net帮助类帮助文档

新建.shfbproj项目

image-20230602092413995

配置项目

配置build

image-20230602092438559

配置help file

image-20230602092455675

添加xml及dll 等资源文件

image-20230602092513328

编译构建文档

使用shfb gui工具

image-20230602092543520

自定义配置生成方法

默认情况下dll中所有方法和属性都会生成对应文档，也可以根据自己需要只把DLL中需要的类或方法生成文档，可通过如下图配置：

image-20230602103610929

image-20230602103624339