如何在c# dll中为方法添加帮助文档

本文关键字:方法 添加 帮助 文档 dll | 更新日期: 2023-09-27 18:02:18

我想添加帮助/文档文本到我正在c#中构建的库。我使用///来创建标签,当我在我的图书馆项目中使用我的图书馆的方法时,这工作得很好。例如:

如果我的库有两个类Car和Person,如果我输入Person

Car.StartEngi

VS的自动完成将建议使用StartEngine方法,我将看到该方法的摘要,例如"此方法将启动汽车的引擎"。

但是当我编译并尝试在单独的解决方案上引用dll时,问题就出现了。在新的解决方案中,我已经添加了相应的引用和using语句,但是当我写

Car.StartEngi

VS确实会推荐使用StartEngine,但我看不到文档。有人知道为什么吗?在构建库时需要添加一些参数吗?

p。生成dll的库中的所有方法都是公共的

如何在c# dll中为方法添加帮助文档

在你的项目设置的Build页面,你需要打开"XML文档文件"。如果您将XML文档文件与程序集一起复制,那么您应该能够在其他项目中看到该文档。