CA1030: Utilizar eventos cuando sea apropiado

  • Artículo
Propiedad Value
Identificador de la regla CA1030
Título Utilizar eventos cuando sea apropiado
Categoría Diseño
La corrección es problemática o no problemática Poco problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

Un nombre de método comienza con uno de los siguientes elementos:

  • AddOn
  • RemoveOn
  • Fire
  • Raise

De forma predeterminada, esta regla solo examina los métodos visibles externamente, pero es configurable.

Descripción de la regla

Esta regla detecta métodos que tienen nombres que normalmente se utilizarían para eventos. Los eventos siguen el modelo de diseño de observador o de publicación-suscripción; se utilizan cuando un cambio de estado en un objeto debe comunicarse a otros objetos. Si se llama a un método en respuesta a un cambio de estado claramente definido, un controlador de eventos debe invocar al método. Los objetos que llaman al método deben provocar eventos en lugar de llamar directamente al método.

Algunos ejemplos comunes de eventos se encuentran en las aplicaciones de interfaz de usuario, en las que una acción del usuario, como hacer clic en un botón, hace que se ejecute un segmento de código. El modelo de eventos de .NET no se limita a las interfaces de usuario. Debe usarse en cualquier lugar en el que deba comunicar cambios de estado a uno o varios objetos.

Cómo corregir infracciones

Si se llama al método cuando cambia el estado de un objeto, considere la posibilidad de cambiar el diseño para usar el modelo de eventos de .NET.

Cuándo suprimir las advertencias

Suprima una advertencia de esta regla si el método no funciona con el modelo de eventos de .NET.

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Configuración del código para analizar

Use la opción siguiente para configurar en qué partes del código base ejecutar esta regla.

Puede configurar esta opción solo para esta regla, para todas las reglas a las que se aplica o para todas las reglas de esta categoría (Diseño) a las que se aplica. Para más información, vea Opciones de configuración de reglas de calidad de código.

Incluir superficies de API específicas

Puede configurar en qué partes del código base ejecutar esta regla, en función de su accesibilidad. Por ejemplo, para especificar que la regla solo se debe ejecutar en la superficie de API no públicas, agregue el siguiente par clave-valor a un archivo .editorconfig en el proyecto:

dotnet_code_quality.CAXXXX.api_surface = private, internal