CA1511: Usar o auxiliar de geração de ArgumentException

Artigo
11/21/2023

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

Causa

O código verifica se um argumento é null ou uma cadeia de caracteres vazia e gera uma ArgumentExceptioncondicionalmente.

Descrição da regra

As verificações de argumento 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 ArgumentException.ThrowIfNullOrEmpty(String, String), 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 CA1511:

void M(string arg)
{
    if (string.IsNullOrEmpty(arg))
        throw new ArgumentException("", "arg");
}

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

void M(string arg)
{
    ArgumentException.ThrowIfNullOrEmpty(arg);
}

Como corrigir violações

Substitua o bloco if que gera a exceção por uma chamada a ArgumentException.ThrowIfNullOrEmpty(String, String). 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 CA1511
// The code that's violating the rule is on this line.
#pragma warning restore CA1511

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

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

Compartilhar via