CA1046: Nie przeciążaj operatora equals w typach referencyjnych
| Nieruchomość | Wartość |
|---|---|
| Identyfikator reguły | CA1046 |
| Tytuł | Nie przeciążaj operatora «equals» w typach referencyjnych |
| Kategoria | Projekt |
| Poprawka powoduje problemy lub nie powoduje problemów | Kluczowa |
| Domyślnie włączone na platformie .NET 9 | Nie. |
Przyczyna
Publiczny lub zagnieżdżony publiczny typ referencyjny przeciąża operator równości.
Opis reguły
Dla typów referencyjnych domyślna implementacja operatora równości jest prawie zawsze poprawna. Domyślnie dwa odwołania są równe tylko wtedy, gdy wskazują ten sam obiekt.
Jak naprawić naruszenia
Aby naprawić naruszenie tej reguły, usuń implementację operatora równości.
Kiedy pomijać ostrzeżenia
Można bezpiecznie pominąć ostrzeżenie z tej reguły, gdy typ odwołania zachowuje się jak wbudowany typ wartości. Jeśli ma sens dodawanie lub odejmowanie wystąpień danego typu, prawdopodobnie poprawne jest zaimplementowanie operatora równości i zignorowanie naruszenia.
Pomijanie ostrzeżenia
Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.
#pragma warning disable CA1046
// The code that's violating the rule is on this line.
#pragma warning restore CA1046
Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.
[*.{cs,vb}]
dotnet_diagnostic.CA1046.severity = none
Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.
Konfigurowanie kodu do analizowania
Użyj następującej opcji, aby skonfigurować, na które części bazy kodu ma być stosowana ta reguła.
Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, do których ma ona zastosowanie, lub dla wszystkich reguł w tej kategorii (Projekt), których dotyczy. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.
Uwzględnij określone powierzchnie interfejsu API
Możesz skonfigurować, na które części bazy kodu ma być stosowana ta reguła, na podstawie poziomu ich dostępności, ustawiając opcję api_surface. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:
dotnet_code_quality.CAXXXX.api_surface = private, internal
Notatka
Zastąp część XXXXCAXXXX identyfikatorem odpowiedniej reguły.
Przykład 1
W poniższym przykładzie pokazano zachowanie domyślne podczas porównywania dwóch odwołań.
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($"({a},{b})");
}
}
Przykład 2
Poniższa aplikacja porównuje niektóre referencje.
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 {a} and b = new {b} are equal? {(a.Equals(b) ? "Yes" : "No")}");
Console.WriteLine($"c and a are equal? {(c.Equals(a) ? "Yes" : "No")}");
Console.WriteLine($"b and a are == ? {(b == a ? "Yes" : "No")}");
Console.WriteLine($"c and a are == ? {(c == a ? "Yes" : "No")}");
}
}
Ten przykład generuje następujące wyniki:
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
