CA1005: Evite parâmetros excessivos em tipos genéricos
| Propriedade | valor |
|---|---|
| ID da regra | CA1005 |
| Cargo | Evite parâmetros excessivos em tipos genéricos |
| Categoria | Desenho |
| A correção está quebrando ou não quebrando | Quebrando |
| Habilitado por padrão no .NET 8 | Não |
Causa
Um tipo genérico visível externamente tem mais de dois parâmetros de tipo.
Por padrão, essa regra examina apenas 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 o que cada parâmetro de tipo representa. Geralmente é óbvio com um parâmetro de tipo, como em , e em certos casos com dois parâmetros de tipo, como em List<T>Dictionary<TKey, TValue>. Se existirem mais de dois parâmetros de tipo, a dificuldade se torna muito grande para a maioria dos usuários (por exemplo, TooManyTypeParameters<T, K, V> em 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 usar no máximo dois parâmetros de tipo.
Quando suprimir avisos
Não suprima um aviso desta 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
Se você quiser apenas suprimir uma única violação, adicione diretivas de pré-processador ao seu arquivo de origem para desativar e, em seguida, reativar 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 de um arquivo, pasta ou projeto, defina sua gravidade como none no arquivo de configuração.
[*.{cs,vb}]
dotnet_diagnostic.CA1005.severity = none
Para obter mais informações, consulte Como suprimir avisos de análise de código.
Configurar código para análise
Use a opção a seguir para configurar em quais partes da sua base de código executar essa regra.
Você pode configurar essa opção apenas para esta regra, para todas as regras às quais ela se aplica ou para todas as regras nesta categoria (Design) às quais ela se aplica. Para obter mais informações, consulte Opções de configuração da regra de qualidade de código.
Incluir superfícies de API específicas
Você pode configurar em quais partes da sua base de código executar essa regra, com base em sua acessibilidade. Por exemplo, para especificar que a regra deve ser executada somente na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig em seu projeto:
dotnet_code_quality.CAXXXX.api_surface = private, internal
Regras conexas
CA1010: Coleções devem implementar interface genérica
CA1000: Não declarar membros estáticos em tipos genéricos
CA1002: Não exponha listas genéricas
CA1003: Usar instâncias genéricas do manipulador de eventos
