使用Sandcastle构建API Web文档
安装
参考:四种Sandcastle方法生成c#.net帮助类帮助文档
操作
使用Sandcastle生成Api文档需要使用对应程序集的注释xml + 程序集dll作为数据源,通过对xml + dll数据解析生成文档;所以主体步骤如下:
- 程序集资源生成
- 创建配置.shfbproj项目
- 编译构建文档
1-程序集资源生成
1. 生成程序集Api Xml
配置需要生成的程序集Api Xml,默认生成到\bin\Debug\xxx下
2. 输出文件
2-创建配置.shfbproj项目
此处为使用 Sandcastle Help File Builder GUI进行项目的创建、配置;
当然,你也可以使用vs创建,前提是需要安装vs插件包:四种Sandcastle方法生成c#.net帮助类帮助文档
1. 新建.shfbproj项目
2. 配置项目
配置build
配置help file
添加xml及dll 等资源文件
3-编译构建文档
1. 使用shfb gui工具
开始构建
完成构建
2. 使用cmd
前提:需要使用dotnet,依赖.net framework 4.8 以及安装SHFB
命令
使用如下命令进行构建
# 命令格式:msbuild [.shfbproj路径]
# 默认生成文件与.shfbproj同一目录下的Help文件夹中
dotnet build D:\\Builder\\Builder.Sample.shfbproj