c# - 编译器警告 CS1591 "Missing XML Comment"未显示，我希望它显示

Question

我已经搜索过，但只找到了想要禁止显示此警告的人提出的问题，例如 Visual Studio Disabling Missing XML Comment Warning ，或者如何仅对某些类型的成员显示它，或者如何将它添加到私有(private)成员。

但是对我来说，这个警告从未在我的任何 Visual Studio 副本中显示过……我希望它显示。直到今天我才知道这个警告存在。我喜欢记录我的代码，并且想知道我没有遗漏任何地方。

使用上面的链接，我已经在接受的答案中查看了禁用它的建议，并检查了在我不知情或不记得的情况下，没有一个是已经完成的。

然而，这在我近年来使用的所有 Visual Studio 副本、VS2013 Pro 和 VS2013 Express 以及 VS2015 Community 中都在发生(或没有发生)。许多项目都是一样的，包括我自己从头开始的项目和我从其他开发人员那里继承的项目。

我需要做些什么才能在这些版本中启用它吗？我很困惑为什么我没有看到它。

Answer 1

您必须要求 Visual Studio 在构建过程中输出一个 XML 文档文件才能收到这些警告。

如果没有该设置，Visual Studio 将忽略那些 XML 注释，但在同一解决方案中除外。如果文档也是同一解决方案的一部分，Visual Studio 将以智能感知和鼠标悬停在代码中显示文档，但它不会提示缺少或不正确的项目。

您要查找的设置在项目属性中:

请注意，此设置会根据构建配置进行更改，因此如果您希望两种构建配置都收到警告，则应为 DEBUG 和 RELEASE 启用它。