c# - 如何在 C# dll 中的方法上添加帮助文档？

Question

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

如果我的图书馆有 2 个类 Car 和 Person，如果我输入 Person

Car.StartEngi

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

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

Car.StartEngi

VS 确实会推荐使用 StartEngine 但我看不到文档。有谁知道为什么？构建库时是否需要添加一些参数？

PD库中所有生成dll的方法都是public的

Answer 1

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