CA1852: selar tipos internos
Property | Valor |
---|---|
ID da regra | CA1852 |
Título | Tipos internos de vedação |
Categoria | Desempenho |
Correção interruptiva ou sem interrupção | Sem interrupção |
Versão introduzida | .NET 7 |
Habilitado por padrão no .NET 8 | Não |
Causa
Um tipo que não é acessível fora de seu assembly e não tem subtipos dentro do assembly que o contém não é marcado com sealed
(NotInheritable
no Visual Basic).
Descrição da regra
Quando um tipo não é acessível fora de seu assembly e não tem subtipos dentro do assembly que o contém, ele pode ser selado com segurança. Selar os tipos pode aprimorar o desempenho. Para obter mais informações, consulte Proposta do analisador: selar tipos internos/privados].
Se você aplicar System.Runtime.CompilerServices.InternalsVisibleToAttribute ao assembly que está sendo analisado, essa regra não sinalizará os tipos que não estão marcados como sealed
por padrão porque um campo poderá ser utilizado por um assembly amigável. Para analisar o assembly mesmo assim, confira Configurar código para análise.
Como corrigir violações
Marque o tipo como sealed
(NotInheritable
no Visual Basic).
Exemplo
O seguinte snippet de código mostra uma violação do CA1852:
internal class C
{ }
Class C
End Class
O seguinte snippet de código conserta a violação:
internal sealed class C
{ }
NotInheritable Class C
End Class
Quando suprimir avisos
É seguro fechar um aviso se o desempenho não é uma preocupação.
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 CA1852
// The code that's violating the rule is on this line.
#pragma warning restore CA1852
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.CA1852.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 (Desempenho) às quais ela se aplica. Para saber mais, confira Opções de configuração de regra de qualidade de código.
Ignorar o atributo InternalsVisibleTo
Por padrão, essa regra será desabilitada se o assembly que está sendo analisado usar InternalsVisibleToAttribute para expor os símbolos internos. Para especificar que a regra deverá ser executada mesmo se o assembly estiver marcado com InternalsVisibleToAttribute, adicione o seguinte par chave-valor a um arquivo .editorconfig no seu projeto:
dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true
Esta opção está disponível desde o .NET 8.