针对内部接口禁用 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

属性与其具有“朋友”关系的任何程序集都是可见的。记录内部类型（包括接口）的公共成员通常是一个好主意，除非您有真正令人信服的理由不这样做；至少，您将在调用时受益于 IntelliSense 文档。

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

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

Answer 2

在 stylecop.json 文件中添加 "documentExposedElements": false 键值对可修复 SA1600 问题。

{
  // ACTION REQUIRED: This file was automatically added to your project, but it
  // will not take effect until additional steps are taken to enable it. See the
  // following page for additional information:
  //
  // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/EnableConfiguration.md

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

我希望这有帮助。