如何在 C# dll 中添加有关方法的帮助文档？

Question

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

如果我的图书馆有 2 类 辆车和人，如果我输入人

Car.StartEngi

VS 的自动完成将建议使用 StartEngine 方法，我将看到该方法的摘要，例如 "This method will start the engine of the car"。

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

Car.StartEngi

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

P.D所有生成dll的库方法都是public

Answer 1

您需要在项目设置的构建页面上启用 "XML documentation file"。如果您将 XML 文档文件与您的程序集一起复制，那么您应该能够在其他项目中看到该文档。