为内部接口禁用 StyleCop 的 SA1600 规则

Question

StyleCop.Analyzers: 1.1.118

我的stylecop.json:

 {
      "$schema":
        "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
      "settings": {
        "documentationRules": {
          "companyName": "ShapeCrawler",
          "documentInternalElements": false
        }
      }
    }

样本：

是否可以禁用内部接口的“SA1600：应记录元素”规则？

Answer 1

根据定义，内部接口对程序集中的所有类型以及通过 InternalsVisibleTo 属性与其具有“朋友”关系的任何程序集都是可见的。记录 public 内部类型（包括接口）的成员通常是个好主意，除非你有真正令人信服的理由不这样做；至少，您将在通话时受益于 IntelliSense 文档。

话虽如此，如果您决定不记录它们，请将类型包装在以下内容中：

#pragma warning disable 1591
[Your code here]
#pragma warning enable 1591

为内部接口禁用 StyleCop 的 SA1600 规则

Disable StyleCop's SA1600 rule for internal interfaces

.net

code-analysis

coding-style

stylecop

visual-studio