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

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

如果我的图书馆有2班汽车和人物，如果人一I型

Car.StartEngi

VS的自动完成会建议使用StartEngine methos和我会看到的总结，对于方法，例如“这种方法将启动汽车的发动机”。

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

Car.StartEngi

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

Pd积所有在生成的dll库的方法是公众

来源

2015-07-10 Yoiku

退后一会儿。 “这种方法会启动汽车发动机”究竟是什么意思告诉你'car.StartEngine（）'不会告诉你？你的“文档”在这里没有任何用处。 –

您需要创建文档XML文件。编译器有一个[选项为此]（https://msdn.microsoft.com/en-us/library/3260k4x7.aspx），应该在相应的[Visual Studio设置页面]（https：// msdn .microsoft.com/en-us/library/vstudio/kb4wyys2（v = vs.100）.aspx）（项目属性>编译>输出> XML文档文件）。 –

@DavidArno，我假设这只是一个简化的例子，OP实际上并不是试图启动一辆汽车的引擎...... –

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

来源

2015-07-10 15:24:20 RogerN

谢谢！它的工作，这真的帮助完整 – Yoiku

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

回答

相关问题