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

Question

是否可以配置.editorconfig文件以在缺少 XML 文档的项目上显示警告/错误？

很高兴在编辑器中看到这样的警告。

提前致谢。

Answer 1

如果您在项目文件（或 Directory.Build.props）中添加<GenerateDocumentationFile>true</GenerateDocumentationFile>属性，并将警告级别设置为至少 4（默认值），则会启用CS1591警告（缺少 XML公开可见类型或成员“Foo”的评论）。

您还可以通过添加StyleCop.Analyzers NuGet package 来获取其他规则， 这里列出了一大堆规则（这些 SA16xx 规则也需要启用相同的项目属性，否则您将收到 SA0001 警告）。

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