CA1046: Não sobrecarregar o operador equals em tipos de referência
| Property | Valor |
|---|---|
| ID da regra | CA1046 |
| Título | Não sobrecarregar o operador equals em tipos de referência |
| Categoria | Projetar |
| Correção interruptiva ou sem interrupção | Quebra |
| Habilitado por padrão no .NET 9 | Não |
Causa
Um tipo de referência pública aninhada ou pública sobrecarrega o operador de igualdade.
Descrição da regra
Para tipos de referência, a implementação padrão do operador de igualdade está quase sempre correta. Por padrão, duas referências só serão iguais se apontarem para o mesmo objeto.
Como corrigir violações
Para corrigir uma violação dessa regra, remova a implementação do operador de igualdade.
Quando suprimir avisos
É seguro suprimir um aviso dessa regra quando o tipo de referência se comporta como um tipo de valor interno. Se for significativo fazer adição ou subtração em instâncias do tipo, provavelmente será correto implementar o operador de igualdade e suprimir a violação.
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 CA1046
// The code that's violating the rule is on this line.
#pragma warning restore CA1046
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.CA1046.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 (Design) à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
Exemplo 1
O exemplo a seguir demonstra o comportamento padrão ao comparar as duas referências.
public class MyReferenceType
{
private int a, b;
public MyReferenceType(int a, int b)
{
this.a = a;
this.b = b;
}
public override string ToString()
{
return String.Format("({0},{1})", a, b);
}
}
Exemplo 2
O aplicativo a seguir compara algumas referências.
public class ReferenceTypeEquality
{
public static void Main1046()
{
MyReferenceType a = new MyReferenceType(2, 2);
MyReferenceType b = new MyReferenceType(2, 2);
MyReferenceType c = a;
Console.WriteLine("a = new {0} and b = new {1} are equal? {2}", a, b, a.Equals(b) ? "Yes" : "No");
Console.WriteLine("c and a are equal? {0}", c.Equals(a) ? "Yes" : "No");
Console.WriteLine("b and a are == ? {0}", b == a ? "Yes" : "No");
Console.WriteLine("c and a are == ? {0}", c == a ? "Yes" : "No");
}
}
Esse exemplo gera a saída a seguir:
a = new (2,2) and b = new (2,2) are equal? No
c and a are equal? Yes
b and a are == ? No
c and a are == ? Yes
