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

【问题标题】：Disable StyleCop's SA1600 rule for internal interfaces为内部接口禁用 StyleCop 的 SA1600 规则
【发布时间】：2021-10-16 20:25:08
【问题描述】：

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：应记录元素”规则？

【问题讨论】：

标签： .net visual-studio coding-style code-analysis stylecop

【解决方案1】：

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

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

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

【讨论】：

“内部接口是公开的” 嗯，不知道。
@AdamShakhabov 一个更好的术语应该是“可见”。我会更新评论以反映这一点。