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

  • Artículo
Propiedad Value
Identificador de la regla CA1005
Título Evitar los parámetros excesivos en tipos genéricos
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 genérico visible externamente tiene más de dos parámetros de tipo.

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

Descripción de la regla

Cuantos más parámetros type contenga un tipo genérico, más difícil resulta saber y recordar qué representa cada uno de ellos. Normalmente, esto resulta evidente con un parámetro de tipo, como en List<T>, y en algunos casos con dos parámetros de tipo, como en Dictionary<TKey, TValue>. Si existen más de dos parámetros de tipo, la dificultad resulta excesiva para la mayoría de los usuarios (por ejemplo, TooManyTypeParameters<T, K, V> en C# o TooManyTypeParameters(Of T, K, V) en Visual Basic).

Cómo corregir infracciones

Para corregir una infracción de esta regla, cambie el diseño para que no use más de dos parámetros de tipo.

Cuándo suprimir las advertencias

No suprima una advertencia de esta regla a menos que el diseño requiera sí o sí más de dos parámetros de tipo. Proporcionar tipos genéricos en una sintaxis fácil de entender y usar reduce el tiempo necesario para aprender y aumentar la tasa de adopción de nuevas bibliotecas.

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

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

CA1010: Las colecciones deben implementar la interfaz genérica

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

CA1002: No exponer listas genéricas

CA1003: Utilizar instancias genéricas de controlador de eventos

Vea también