编译器警告CS1591“缺少XML注释”未显示，我希望它

Question

我搜索过，只发现了想要取消此警告的人提出的问题，例如Visual Studio Disabling Missing XML Comment Warning，或者仅针对某些类型的成员展示该问题，或者如何将其添加到私人成员。

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

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

然而，在我近年来使用的Visual Studio的所有副本中，VS2013 Pro和VS2013 Express以及VS2015社区都发生了这种情况（或者没有发生）。并且在许多项目中都是一样的，包括我从头开始创建的项目以及我从其他开发人员那里继承的项目。

在这些版本中是否需要执行某些操作才能启用它？我很困惑为什么我没有看到它。

Answer 1

您必须要求Visual Studio输出XML文档文件作为构建过程的一部分以获取这些警告。

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

您正在寻找的设置位于项目属性中：

请注意，每个构建配置都会更改此设置，因此如果您需要两个构建配置的警告，则应为DEBUG和RELEASE启用此设置。

Answer 2

使用解决方案根目录中的Directory.build.props文件为解决方案中的所有项目将此属性设置为on。这样一来，您就可以通过一行同时为所有项目打开它。 添加此行：

 <GenerateDocumentationFile>true</GenerateDocumentationFile>

在Directory.Build.props的以下部分中：

<Project>
  <PropertyGroup>    
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
  </PropertyGroup>  
</Project>