CA1030. По возможности используйте события

Значение
Идентификатор правила CA1030
Категория Оформление
Исправление является критическим или не критическим Не критическое

Причина

Имя метода начинается с одного из следующего:

  • AddOn
  • RemoveOn
  • Fire
  • Raise

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

Описание правила

Данное правило отслеживает методы с именами, которые, как правило, используются для событий. События следуют за шаблоном разработки Observer или Publish-Subscribe; они используются, когда изменение состояния одного объекта должно быть донесено до других объектов. Если метод вызывается в ответ на четко определенное изменение состояния, то этот вызов должен осуществляться с помощью обработчика событий. Объекты, вызывающие методы, должны создавать события, а не вызывать методы напрямую.

Некоторые распространенные примеры событий находятся в приложениях пользовательского интерфейса, в которых пользовательское действие, например нажатие кнопки, приводит к выполнению сегмента кода. Модель событий .NET не ограничивается пользовательскими интерфейсами. Ее следует использовать в любом месте, где необходимо передать изменения состояния одному или нескольким объектам.

Устранение нарушений

Если метод вызывается при изменении состояния объекта, попробуйте изменить структуру так, чтобы она использовала модель событий .NET.

Условия для отключения предупреждений

Скройте предупреждение о нарушении этого правила, если метод не работает с моделью событий .NET.

Отключение предупреждений

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

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

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

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

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

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Design.severity = none

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

Настройка кода для анализа

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

Этот параметр можно настроить только для некоторого правила, для всех правил или для всех правил в этой категории (конструктор). Дополнительные сведения см. в статье Параметры конфигурации правила качества кода.

Включение определенных контактных зон API

Вы можете настроить, для каких частей базы кода следует выполнять это правило в зависимости от их доступности. Например, чтобы указать, что правило должно выполняться только для закрытой контактной зоны API, добавьте следующую пару "ключ-значение" в файл EDITORCONFIG в своем проекте:

dotnet_code_quality.CAXXXX.api_surface = private, internal