配置 .editorconfig 中缺少 xml 注释的警告 (Visual Studio 2019)

Question

是否可以配置

.editorconfig

文件来显示缺少 XML 文档的项目的警告/错误？

如果在编辑器中看到这样的警告那就太好了。

提前致谢。

Answer 1

如果您在项目文件（或 Directory.Build.props）中添加

<GenerateDocumentationFile>true</GenerateDocumentationFile>

属性，并将 警告级别 设置为至少 4（默认值），则将为 CS1591（缺少 XML）启用警告对公开可见类型或成员“Foo”的评论）。

您还可以通过添加 StyleCop.Analyzers NuGet 包来获取其他规则，其中概述了here的一大堆规则（这些 SA16xx 规则还需要启用相同的项目属性，否则您将收到 SA0001 警告).

这些都适用于公开暴露的 API，我不确定如何为非公开 API 配置它们。

Answer 2

您可以在

.editorconfig

文件中禁用 CS1591。只需在

[*.cs]

部分添加以下行：

# CS1591: Missing XML comment for publicly visible type or member
dotnet_diagnostic.CS1591.severity = none