CA1513: Usar o auxiliar de geração de ObjectDisposedException

Artigo
11/22/2023

Propriedade	Valor
ID da regra	CA1513
Título	Usar o auxiliar de geração de ObjectDisposedException
Categoria	Facilidade de manutenção
Correção interruptiva ou sem interrupção	Sem interrupção
Habilitado por padrão no .NET 8	Como sugestão

Causa

O código verifica se um objeto foi descartado e gera uma ObjectDisposedException condicionalmente.

Descrição da regra

As verificações de objeto têm um impacto substancial no tamanho do código e costumam dominar o código quanto a funções pequenas e setters de propriedade. Essas verificações evitam o inlining e causam poluição substancial no cache de instruções. Métodos auxiliares de geração, como ThrowIf, são mais simples e eficientes do que blocos if que constroem uma nova instância de exceção.

Exemplo

O seguinte snippet de código mostra uma violação da CA1513:

class C
{
    private bool _disposed = false;
    void M()
    {
        if (_disposed)
            throw new ObjectDisposedException(GetType().Name);
    }
}

O seguinte snippet de código mostra a correção:

class C
{
    private bool _disposed = false;
    void M()
    {
        ObjectDisposedException.ThrowIf(_disposed, this);
    }
}

Como corrigir violações

Substitua o bloco if que gera a exceção por uma chamada a ThrowIf. Ou, no Visual Studio, use o menu de lâmpada para corrigir o código automaticamente.

Quando suprimir avisos

Será seguro suprimir uma violação dessa regra se você não estiver preocupado com a manutenção do código. Também não há problema em suprimir violações identificadas como falsos positivos.

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

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

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

Compartilhar via