CA1040: Evitar las interfaces vacías

  • Artículo
Propiedad Value
Identificador de la regla CA1040
Título Evitar las interfaces vacías
Categoría Diseño
La corrección es problemática o no problemática Problemático
Habilitado de forma predeterminada en .NET 8 No

Causa

La interfaz no declara ningún miembro ni implementa dos o más interfaces.

De forma predeterminada, esta regla solo examina las interfaces visibles externamente, pero es configurable.

Descripción de la regla

Las interfaces definen miembros que proporcionan un comportamiento o acuerdo de uso. Cualquier tipo puede adoptar la funcionalidad descrita por la interfaz sin tener en cuenta dónde aparece el tipo en la jerarquía de herencia. Un tipo implementa una interfaz proporcionando las implementaciones para los miembros de la interfaz. Una interfaz vacía no define ningún miembro. Por consiguiente, no define un contrato que se pueda implementar.

Si el diseño incluye interfaces vacías que se espera que los tipos implementen, probablemente esté usando una interfaz como marcador o forma de identificar un grupo de tipos. Si esta identificación se va a producir en tiempo de ejecución, la manera correcta de lograrlo es usar un atributo personalizado. Utilice la presencia o ausencia del atributo o las propiedades del atributo para identificar los tipos de destino. Si la identificación debe realizarse en tiempo de compilación, es aceptable usar una interfaz vacía.

Cómo corregir infracciones

Quite la interfaz o agréguele miembros. Si la interfaz vacía se usa para etiquetar un conjunto de tipos, reemplace la interfaz por un atributo personalizado.

Cuándo suprimir las advertencias

Es seguro suprimir una advertencia de esta regla cuando la interfaz se utiliza para identificar un conjunto de tipos en tiempo de compilación.

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 CA1040
// The code that's violating the rule is on this line.
#pragma warning restore CA1040

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.CA1040.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

Ejemplo

En el ejemplo siguiente se muestra una interfaz vacía.

// Violates rule
public interface IBadInterface
{
}

' Violates rule
Public Interface IBadInterface
End Interface