Partilhar via

CA1801: Rever parâmetros não utilizados

  • Artigo
Property valor
ID da regra CA1801
Título Rever parâmetros não utilizados
Categoria Utilização
A correção está quebrando ou não quebrando Sem quebra - Se o membro não estiver visível fora da assembleia, independentemente da alteração que fizer.

Non-breaking - Se você alterar o membro para usar o parâmetro dentro de seu corpo.

Quebrando - Se você remover o parâmetro e ele estiver visível fora da montagem.
Habilitado por padrão no .NET 9 Não

Motivo

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

Esta 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 abstract modificador (MustOverride no Visual Basic).

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

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

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

Esta regra não sinaliza parâmetros nomeados com o símbolo de descarte , por exemplo, _, _1, e _2. Isso reduz o ruído de aviso em parâmetros que são 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 é implicitamente acessado em tempo de execução por uma estrutura, mas não é referenciado no código.

Nota

Esta regra foi preterida em favor de IDE0060. Para obter informações sobre como impor o analisador de IDE0060 na compilação, consulte Análise de estilo de código.

Descrição da regra

Revise os parâmetros em métodos não virtuais que não são usados no corpo do método para garantir que não haja incorreção em relação à falha de acessá-los. Os parâmetros não utilizados incorrem em 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 os avisos desta regra se o parâmetro tiver de 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 de quebra) ou use o parâmetro no corpo do método (uma alteração sem quebra).

Quando suprimir avisos

É seguro suprimir um aviso desta regra:

  • Em código enviado anteriormente para o qual a correção seria uma alteração de quebra.

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

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

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

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

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.

Incluir superfícies de API específicas

Você pode configurar em quais partes da sua base de código executar essa regra, com base em sua acessibilidade. Por exemplo, para especificar que a regra deve ser executada somente na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig em seu 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 satisfaz a 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);
}