CA1002: Não exponha listas genéricas
| Propriedade | valor |
|---|---|
| ID da regra | CA1002 |
| Cargo | Não exponha listas genéricas |
| Categoria | Desenho |
| A correção está quebrando ou não quebrando | Quebrando |
| Habilitado por padrão no .NET 8 | Não |
Causa
Um tipo contém um membro visível externamente que é um tipo, retorna um tipo ou cuja assinatura inclui um System.Collections.Generic.List<T>List<T>List<T> parâmetro.
Por padrão, essa regra examina apenas tipos visíveis externamente, mas isso é configurável.
Descrição da regra
System.Collections.Generic.List<T> é uma coleção genérica projetada para desempenho e não herança. List<T> não contém membros virtuais que facilitam a alteração do comportamento de uma classe herdada. As seguintes coleções genéricas são projetadas para herança e devem ser expostas em vez de List<T>.
Como corrigir violações
Para corrigir uma violação dessa regra, altere o System.Collections.Generic.List<T> tipo para uma das coleções genéricas projetadas para herança.
Quando suprimir avisos
Não suprima um aviso desta regra, a menos que o assembly que gera esse aviso não se destine a ser uma biblioteca reutilizável. Por exemplo, seria seguro suprimir esse aviso em um aplicativo ajustado ao desempenho em que um benefício de desempenho fosse obtido com o uso de listas genéricas.
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 CA1002
// The code that's violating the rule is on this line.
#pragma warning restore CA1002
Para desabilitar a regra de um arquivo, pasta ou projeto, defina sua gravidade como none no arquivo de configuração.
[*.{cs,vb}]
dotnet_diagnostic.CA1002.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
CA1005: Evite parâmetros excessivos em tipos genéricos
CA1010: Coleções devem implementar interface genérica
CA1000: Não declarar membros estáticos em tipos genéricos
CA1003: Usar instâncias genéricas do manipulador de eventos
