CA1812: Evite classes internas não instanciadas

Causa

Um tipo interno (nível de montagem) nunca é instanciado.

Descrição da regra

Esta regra tenta localizar uma chamada para um dos construtores do tipo e relata uma violação se nenhuma chamada for encontrada.

Os seguintes tipos não são examinados por esta regra:

• Tipos de valor
• Tipos abstratos
• Enumerações
• Delegados
• Tipos de matriz emitidos pelo compilador
• Tipos que não podem ser instanciados e que apenas definem static métodos.

Se você aplicar System.Runtime.CompilerServices.InternalsVisibleToAttribute ao assembly que está sendo analisado, essa regra não sinalizará tipos marcados como internal (Friend no Visual Basic) por padrão, porque um campo pode ser usado por um assembly amigo. Para analisar o assembly de qualquer maneira, consulte Configurar código para analisar.

Como corrigir violações

Para corrigir uma violação desta regra, remova o tipo ou adicione o código que o utiliza. Se o tipo contiver apenas static métodos, adicione o modificador ao tipo para impedir que o static compilador emita um construtor de instância pública padrão.

Quando suprimir avisos

É seguro suprimir uma advertência desta regra. Recomendamos que você suprima esse aviso nas seguintes situações:

• A classe é criada por meio de métodos de reflexão tardios, como System.Activator.CreateInstance.

• A classe é registrada em um contêiner de inversão de controle (IoC) como parte do padrão de injeção de dependência.

• A classe é criada automaticamente pelo tempo de execução ou ASP.NET. Alguns exemplos de classes criadas automaticamente são aquelas que implementam System.Configuration.IConfigurationSectionHandler ou System.Web.IHttpHandler.

• A classe é usada como um parâmetro de tipo em uma definição de classe e tem uma new restrição. O exemplo a seguir será sinalizado pela regra CA1812:

  internal class MyClass
  {
      public void DoSomething()
      {
      }
  }
  public class MyGeneric<T> where T : new()
  {
      public T Create()
      {
          return new T();
      }
  }
  
  MyGeneric<MyClass> mc = new MyGeneric<MyClass>();
  mc.Create();
  

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

Para desabilitar a regra de um arquivo, pasta ou projeto, defina sua gravidade como none no arquivo de configuração.

[*.{cs,vb}]
dotnet_diagnostic.CA1812.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.

• Ignorar o atributo InternalsVisibleTo

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 (Desempenho) às quais ela se aplica. Para obter mais informações, consulte Opções de configuração da 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 seus símbolos internos. Para especificar que a regra deve ser executada mesmo se o assembly estiver marcado com InternalsVisibleToAttribute, adicione o seguinte par chave-valor a um arquivo .editorconfig em seu projeto:

dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true

Esta opção está disponível a partir do .NET 8.

Regras conexas

• CA1801: Rever parâmetros não utilizados