.Net使用SandCastle生成API文档

前人栽树后人乘凉，这位大佬已经总结得很好。

SandCastle API文档生成（c# dll）_吉&祥的博客-CSDN博客一、Sandcastle这个是c#类库方法根据注释生成帮助文档的工具，我们经常会遇到把DLL或者API提供给别人调用的情况，通过在方法中添加注释，然后再用Sandcastle 来自动生成文档给调用者，如下图：图1：这是Sandcastle Help File Builder软件界面图2：这是生成的chm文档还可以直接给出示例代码：图3：还可以直接生成网页二、下载安装下载地址：Help File Builder and Tools v2021.4.9.0最...https://blog.csdn.net/a734797702/article/details/123370814

在实操中要注意一点，在项目中，添加了对应的备注，依然没有写入到帮助文档。

报了[Missing <summary> documentation for ""]

这样的错误。

经另一个帖子的提示：

Sandcastle Help File Builder[Missing <summary> documentation for ""]_南郭未末的博客-CSDN博客

发现是要预先生成一个xml

 

所以 正确的操作是：

1、配置好dll项目的生成，勾上xml文档文件

2、dll项目生成

3、document项目清理、重新生成（注意此时不要打开chm文件，否则无法清理）