CA2255: o atributo ModuleInitializer não deve ser usado em bibliotecas

  • Artigo
Property Valor
ID da regra CA2255
Título O atributo ModuleInitializer não deve ser usado em bibliotecas
Categoria Usage
Correção interruptiva ou sem interrupção Sem interrupção
Habilitado por padrão no .NET 8 Como aviso

Causa

Aplicando ModuleInitializerAttribute a um método em uma biblioteca de classes.

Descrição da regra

O código do aplicativo deve usar os inicializadores de módulo para garantir que os componentes de um aplicativo inicializem antes que o código do aplicativo comece a execução. Se o código da biblioteca declarar um método com o ModuleInitializerAttribute, ele poderá interferir na inicialização do aplicativo e também limitar as capacidades de corte desse aplicativo. Portanto, o código de biblioteca não deve utilizar o atributo ModuleInitializerAttribute.

Como corrigir violações

Em vez de usar os métodos marcados com ModuleInitializerAttribute, a biblioteca deverá expor os métodos que poderão ser utilizados para inicializar os componentes da biblioteca e permitir que o aplicativo invoque o método durante a inicialização do aplicativo.

Quando suprimir avisos

É seguro suprimir avisos dessa regra se uma solução usar uma biblioteca de classes para fins de fatoração de código e o método ModuleInitializerAttribute não fizer parte de uma biblioteca ou pacote compartilhado ou distribuído.

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

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.CA2255.severity = none

Para desabilitar toda essa categoria de regras, defina a gravidade da categoria como none no arquivo de configuração.

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Usage.severity = none

Para obter mais informações, confira Como suprimir avisos de análise de código.

Confira também