CA1801: Examinar parâmetros não utilizados

  • Artigo
Property Valor
ID da regra CA1801
Título Examinar parâmetros não utilizados
Categoria Usage
A correção é com ou sem interrupção Sem interrupção – se o membro não estiver visível fora do assembly, independentemente da alteração que você fizer.

Sem interrupção – se você alterar o membro para usar o parâmetro dentro do respectivo corpo.

Interruptiva – se você remover o parâmetro e ele estiver visível fora do assembly.
Habilitado por padrão no .NET 8 Não

Causa

Uma assinatura de método inclui um parâmetro que não é usado no corpo do método.

Essa regra não examina os seguintes tipos de métodos:

  • Métodos referenciados por um delegado.

  • Métodos usados como manipuladores de eventos.

  • Construtores de serialização (consulte as diretrizes).

  • Métodos de serialização GetObjectData.

  • Métodos declarados com o modificador abstract (MustOverride no Visual Basic).

  • Métodos declarados com o modificador virtual (Overridable no Visual Basic).

  • Métodos declarados com o modificador override (Overrides no Visual Basic).

  • Métodos declarados com o modificador extern (instrução Declare no Visual Basic).

Essa regra não sinaliza parâmetros nomeados com o símbolo descarte, por exemplo, _, _1 e _2. Esse comportamento reduz o ruído de aviso em parâmetros necessários para requisitos de assinatura, por exemplo, um método usado como delegado, um parâmetro com atributos especiais ou um parâmetro cujo valor é acessado implicitamente em tempo de execução por uma estrutura, mas não é referenciado no código.

Observação

Essa regra foi preterida em favor de IDE0060. Para obter informações sobre como impor o analisador IDE0060 no build, consulte a análise de estilo de código.

Descrição da regra

Examine os parâmetros em métodos não virtuais que não são usados no corpo do método para verificar se não há nenhuma incorreção em torno da falha ao acessá-los. Parâmetros não utilizados acarretam custos de manutenção e desempenho.

Às vezes, uma violação dessa regra pode apontar para um bug de implementação no método. Por exemplo, o parâmetro deveria ter sido usado no corpo do método. Suprima avisos dessa regra se o parâmetro precisar existir devido à compatibilidade com versões anteriores.

Como corrigir violações

Para corrigir uma violação dessa regra, remova o parâmetro não utilizado (uma alteração interruptiva) ou use o parâmetro no corpo do método (uma alteração sem interrupção).

Quando suprimir avisos

É seguro suprimir um aviso desta regra:

  • No código enviado anteriormente para o qual a correção seria uma alteração interruptiva.

  • Para o parâmetro this em um método de extensão personalizado para Microsoft.VisualStudio.TestTools.UnitTesting.Assert. As funções na classe Assert são estáticas, portanto, não há necessidade de acessar o parâmetro this no corpo do método.

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

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.CA1801.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.

Incluir superfícies de API específicas

É possível configurar em quais partes da base de código essa regra deverá ser executada, com base na acessibilidade. Por exemplo, para especificar que a regra deverá ser executada apenas na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig no projeto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Por padrão, a regra CA1801 se aplica a todas as superfícies de API (pública, interna e privada).

Exemplo

O exemplo a seguir mostra dois métodos. Um método viola a regra e o outro método atende à regra.

// This method violates the rule.
public static string GetSomething(int first, int second)
{
    return first.ToString(CultureInfo.InvariantCulture);
}

// This method satisfies the rule.
public static string GetSomethingElse(int first)
{
    return first.ToString(CultureInfo.InvariantCulture);
}