Блог

Стилкоп.Анализаторы: 1.1.118

Мой стиль. json:

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

Образец:

Можно ли отключить правило «SA1600: элементы должны быть задокументированы» для внутренних интерфейсов?

По определению, внутренние интерфейсы видны всем типам внутри сборки и всем сборкам, которые имеют с ней «дружеские» отношения с помощью InternalsVisibleTo атрибута. Как правило, рекомендуется документировать общедоступные элементы внутренних типов (включая интерфейсы), если у вас нет действительно веских причин этого не делать; по крайней мере, вы получите выгоду от документации IntelliSense в момент вызова.

Сказав это, если вы решили не документировать их, заверните тип следующим образом:

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