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

Question

我想将帮助/文档文本添加到我在C＃中构建的库中。我正在使用///来创建标签，当我在我的程序中使用我的库的方法时，这很好用。例如：

如果我的图书馆有两个班级Car和Person，如果我输入了Person

Car.StartEngi

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

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

时

Car.StartEngi

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

P.D生成dll的库中的所有方法都是公共的

Answer 1

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