Share via

CA2245: Não atribuir uma propriedade a si mesma

  • Artigo
Property Valor
ID da regra CA2245
Título Não atribuir uma propriedade a si mesma
Categoria Usage
Correção interruptiva ou sem interrupção Sem interrupção
Habilitado por padrão no .NET 8 Como sugestão

Causa

Uma propriedade foi acidentalmente atribuída a si mesma.

Descrição da regra

O compilador C# gera um aviso CS1717: atribuição feita à mesma variável; você queria atribuir outra coisa? quando um campo, símbolo local ou parâmetro é atribuído a si mesmo. Esse erro é comum quando um símbolo local, de parâmetro ou de campo tem um nome semelhante a outro símbolo no escopo. Em vez de usar símbolos diferentes no lado esquerdo e direito da atribuição, o mesmo símbolo foi usado em ambos os lados. Isso leva a uma atribuição redundante do valor para si mesmo e geralmente indica um bug funcional.

Atribuir uma propriedade a si mesma também é um bug funcional semelhante para quase todos os casos do mundo real. No entanto, em alguns casos extremos excepcionais, buscar um valor de propriedade pode ter efeitos colaterais e o novo valor da propriedade é diferente do valor original. Nesse caso, a autoatribuição de propriedade não é redundante e não pode ser removida. Isso impede que o compilador gere um aviso CS1717 para a autoatribuição de propriedade sem introduzir uma alteração interruptiva para esses casos.

A regra CA2245 visa preencher essa lacuna. Ela relata a violação da autoatribuição de propriedade para ajudar a corrigir esses bugs funcionais. Para o pequeno conjunto de casos excepcionais em que a autoatribuição de propriedade é desejável, as violações CA2245 podem ser suprimidas na origem com um comentário de justificativa apropriado.

Como corrigir violações

Para corrigir violações, use símbolos diferentes no lado esquerdo e no lado direito da atribuição. Por exemplo, o seguinte snippet de código mostra uma violação da regra e como corrigi-la:

public class C
{
    private int p = 0;
    public int P { get; private set; }

    public void M(int p)
    {
        // CS1717: Accidentally assigned the parameter 'p' to itself.
        p = p;

        // CA2245: Accidentally assigned the property 'P' to itself.
        P = P;
    }
}

public class C
{
    private int p = 0;
    public int P { get; private set; }

    public void M(int p)
    {
        // No violation, now the parameter is assigned to the field.
        this.p = p;

        // No violation, now the parameter is assigned to the property.
        P = p;
    }
}

Quando suprimir avisos

É seguro suprimir violações dessa regra se a busca de um valor de propriedade puder ter efeitos colaterais e o novo valor da propriedade for diferente do valor original. Nesse caso, a autoatribuição de propriedade não é redundante. Um comentário de justificativa deve ser adicionado à supressão para documentar isso como comportamento esperado.

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

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

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

Confira também