CA1002: No exponer listas genéricas

  • Artículo
Propiedad Value
Identificador de la regla CA1002
Título No exponer listas genéricas
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

Un tipo contiene un miembro visible externamente que es un tipo System.Collections.Generic.List<T>, devuelve un tipo List<T>, o bien cuya firma incluye un parámetro List<T>.

De forma predeterminada, esta regla solo examina los tipos visibles externamente, pero es configurable.

Descripción de la regla

System.Collections.Generic.List<T> es una colección genérica diseñada para el rendimiento y no para la herencia. List<T> no contiene miembros virtuales que faciliten el cambio del comportamiento de una clase heredada. Las siguientes colecciones genéricas se han diseñado para la herencia y deberían exponerse en lugar de List<T>.

Cómo corregir infracciones

Para corregir una infracción de esta regla, cambie el tipo System.Collections.Generic.List<T> a una de las colecciones genéricas diseñadas para la herencia.

Cuándo suprimir las advertencias

No suprima una advertencia de esta regla a menos que el ensamblado que la genera no esté diseñado para ser una biblioteca reutilizable. Por ejemplo, sería seguro suprimir esta advertencia en una aplicación optimizada para el rendimiento en la que se obtuviera una ventaja de rendimiento a partir del uso de listas genéricas.

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

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

CA1005: Evitar los parámetros excesivos en tipos genéricos

CA1010: Las colecciones deben implementar la interfaz genérica

CA1000: No declarar miembros estáticos en tipos genéricos

CA1003: Utilizar instancias genéricas de controlador de eventos

Vea también

Genéricos