【问题标题】:Configure warnings for mising xml comments in .editorconfig (Visual Studio 2019)在 .editorconfig (Visual Studio 2019) 中为缺少 xml 注释配置警告
【发布时间】:2021-01-31 08:24:10
【问题描述】:

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

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

提前致谢。

【问题讨论】:

  • 您使用哪种编程语言?
  • 嗨@Jimmy。我使用 C#。

标签: c# visual-studio-2019 xml-comments editorconfig


【解决方案1】:

如果您在项目文件(或 Directory.Build.props)中添加 <GenerateDocumentationFile>true</GenerateDocumentationFile> 属性,并将您的 warning level 设置为至少 4(默认值),这将启用对 CS1591 的警告(缺失公开可见类型或成员“Foo”的 XML 注释)。

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

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

【讨论】:

  • 谢谢@Jimmy。我已经认为不可能在一个地方配置所有这些东西。但是,感谢您提供有用的提示和链接。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2023-03-04
  • 2021-08-20
  • 2018-06-24
  • 1970-01-01
  • 2020-11-07
  • 2019-09-03
  • 2020-08-09
相关资源
最近更新 更多