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

【问题标题】：How to add help documentation on a method in a C# dll?如何在 C# dll 中的方法上添加帮助文档？
【发布时间】：2015-07-10 15:18:55
【问题描述】：

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

如果我的库有 2 个类 Car 和 Person，如果我输入 Person

Car.StartEngi

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

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

Car.StartEngi

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

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

【问题讨论】：

退后一步。 car.StartEngine() 没有告诉你的“这个方法将启动汽车的引擎”到底告诉你什么？您的“文档”在这里毫无用处。
您需要创建文档 XML 文件。编译器有一个option for this，应该在对应的Visual Studio settings page中启用（项目属性>构建>输出>XML文档文件）。
@DavidArno，我假设这只是一个简化的示例，并且 OP 实际上并没有尝试启动汽车引擎......
是的，你是对的，这只是一个简化的例子 :) RogerN 和 @Jordão 刚刚同时写了这个问题 :) 非常感谢！

【解决方案1】：

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

【讨论】：