CA1505. Избегайте кода, неудобного для поддержки

Тип, метод, поле, свойство или событие имеет низкое значение индекса удобства обслуживания.

Правило сообщает о нарушении, если индекс доступности типа, метода, поля, свойства или события меньше 10. Однако пороговое значение можно настроить.

Индекс удобства поддержки вычисляется с помощью следующих метрик: строк кода, объема программы и цикломатической сложности. (Том программы — это мера сложности понимания типа или метода, основанного на количестве операторов и операндов в коде. Цикломатическая сложность — это мера структурной сложности типа или метода. Дополнительные сведения о метриках кода см. в разделе Измерение сложности и удобства поддержки управляемого кода.

Низкий индекс удобства поддержки означает, что тип или метод скорее всего трудно поддерживать, поэтому его следует переработать.

Чтобы устранить это нарушение, переработайте тип или метод и попробуйте разделить его на меньшие и более специализированные типы или методы.

Это предупреждение можно отключить, если тип или метод невозможно разделить, или если он считается удобным для поддержки, несмотря на большой размер.

Если вы просто хотите отключить одно нарушение, добавьте директивы препроцессора в исходный файл, чтобы отключить и повторно включить правило.

#pragma warning disable CA1505
// The code that's violating the rule is on this line.
#pragma warning restore CA1505

Чтобы отключить правило для файла, папки или проекта, задайте его серьезность none в файле конфигурации.

[*.{cs,vb}]
dotnet_diagnostic.CA1505.severity = none

Дополнительные сведения см. в разделе Практическое руководство. Скрытие предупреждений анализа кода.

Пороговое значение, с помощью которого это правило запускается, и типы символов для анализа. Допустимые типы символов:

• Assembly
• Namespace
• Type
• Method
• Field
• Event
• Property

1. Создайте текстовый файл с именем CodeMetricsConfig.txt.

2. Добавьте требуемое пороговое значение в текстовый файл в следующем формате:

   txt Копировать

   CA1505: 20
   

   В этом примере правило настраивается для запуска, если индекс доступности типа, метода, поля, свойства или события меньше 20.

   txt Копировать

   CA1505(Method): 5
   CA1505(Type): 15
   

   В этом примере правило настраивается для запуска, если индекс удобства обслуживания метода меньше 5 или индекс удобства обслуживания типа меньше 15. В этом файле конфигурации правило будет продолжать отмечать поля, свойства и события, индекс обслуживания которых меньше порогового значения по умолчанию (10).

3. В файле проекта пометьте действие сборки файла конфигурации как AdditionalFiles. Например:

   XML Копировать

   <ItemGroup>
     <AdditionalFiles Include="CodeMetricsConfig.txt" />
   </ItemGroup>
   

• Правила обслуживания
• Оценка сложности и удобства сопровождения управляемого кода