Sandcastle生成文档

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

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

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

程序集资源生成

生成程序集Api Xml

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

Sandcastle生成文档_第1张图片

输出文件

image-20230602092330398

创建配置.shfbproj项目

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

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

新建.shfbproj项目

Sandcastle生成文档_第2张图片

配置项目
配置build

Sandcastle生成文档_第3张图片

配置help file

Sandcastle生成文档_第4张图片

添加xml及dll 等资源文件

Sandcastle生成文档_第5张图片

编译构建文档

使用shfb gui工具

Sandcastle生成文档_第6张图片

自定义配置生成方法

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

Sandcastle生成文档_第7张图片

Sandcastle生成文档_第8张图片

你可能感兴趣的:(工具,c#,c#)