StyleCop.Analyzers：禁用 SA1633 和 SA1652

Question

我已经查阅了配置文档，但找不到任何东西。

我想禁用以下两条规则：

SA1633: The file header is missing or not located at the top of the file.
SA1652: Enable XML documentation output.

我的

stylecop.json

看起来像这样：

{
  "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
  "settings": {
    "orderingRules": {
      "usingDirectivesPlacement": "outsideNamespace"
    }
  }
}

有什么想法吗？

Answer 1

启用和禁用规则是通过规则集文件完成的，而不是配置

.json

文件。 有关使用规则集文件的详细信息，请参阅 https://msdn.microsoft.com/en-us/library/dd264996.aspx。

Answer 2

另一种方法是在 GlobalSuppressions.cs 中指定抑制属性，如下所示：

[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1633:File must have header", Justification = "<Pending>")]
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1652:Enable XML documentation output", Justification = "<Pending>")]

Answer 3

您可以将其添加到 .NET（核心）csproj 文件中：

<PropertyGroup>
  <NoWarn>
    SA1633,SA1652      
  </NoWarn>
</PropertyGroup>

它不会在解决方案级别抑制警告，但我通常想忽略测试项目中与其他地方不同的警告，因此它对我有用。