CA1005: Evitar parâmetros excessivos em tipos genéricos
| Property | Valor |
|---|---|
| ID da regra | CA1005 |
| Título | Evitar parâmetros excessivos em tipos genéricos |
| Categoria | Projetar |
| Correção interruptiva ou sem interrupção | Quebra |
| Habilitado por padrão no .NET 8 | Não |
Causa
Um tipo genérico externamente visível tem mais de dois parâmetros de tipo.
Por padrão, essa regra apenas analisa os tipos visíveis externamente, mas isso é configurável.
Descrição da regra
Quanto mais parâmetros de tipo um tipo genérico contiver, mais difícil será saber e lembrar-se do que cada parâmetro de tipo representa. Isso costuma ser óbvio com um parâmetro de tipo, como em List<T> e em determinados casos que tenham dois parâmetros de tipo, como em Dictionary<TKey, TValue>. Se houver mais de dois parâmetros de tipo, a dificuldade ficará muito grande para a maioria dos usuários (por exemplo, TooManyTypeParameters<T, K, V> in C# ou TooManyTypeParameters(Of T, K, V) no Visual Basic).
Como corrigir violações
Para corrigir uma violação dessa regra, altere o design para que use no máximo dois parâmetros de tipo.
Quando suprimir avisos
Não suprima um aviso dessa regra, a menos que o design exija absolutamente mais de dois parâmetros de tipo. Fornecer genéricos em uma sintaxe fácil de entender e usar reduz o tempo necessário para aprender e aumenta a taxa de adoção de novas bibliotecas.
Suprimir um aviso
Para suprimir apenas uma violação, adicione diretivas de pré-processador ao arquivo de origem a fim de desabilitar e, em seguida, reabilitar a regra.
#pragma warning disable CA1005
// The code that's violating the rule is on this line.
#pragma warning restore CA1005
Para desabilitar a regra em um arquivo, uma pasta ou um projeto, defina a severidade como none no arquivo de configuração.
[*.{cs,vb}]
dotnet_diagnostic.CA1005.severity = none
Para obter mais informações, confira Como suprimir avisos de análise de código.
Configurar código para analisar
Use a opção a seguir para configurar em quais partes da base de código essa regra deve ser executada.
Você pode configurar essa opção apenas para essa regra, para todas as regras às quais ela se aplica ou para todas as regras nessa categoria (Design) às quais ela se aplica. Para saber mais, confira Opções de configuração de regra de qualidade de código.
Incluir superfícies de API específicas
É possível configurar em quais partes da base de código essa regra deverá ser executada, com base na acessibilidade. Por exemplo, para especificar que a regra deverá ser executada apenas na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig no projeto:
dotnet_code_quality.CAXXXX.api_surface = private, internal
Regras relacionadas
CA1010: Coleções devem implementar uma interface genérica
CA1000: Não declarar membros estáticos em tipos genéricos
CA1002: Não expor listas genéricas
CA1003: Usar instâncias do manipulador de eventos genérico
