Udostępnij przez

CA2225: Operator overloads ma nazwanych zastępców

  • Artykuł
Właściwości Wartość
Identyfikator reguły CA2225
Tytuł Przeciążenia operatorów mają nazwane elementy alternatywne
Kategoria Użycie
Poprawka powodująca niezgodność lub niezgodność Niezgodność
Domyślnie włączone na platformie .NET 8 Nie.

Przyczyna

Wykryto przeciążenie operatora i nie znaleziono oczekiwanej metody alternatywnej o nazwie.

Domyślnie ta reguła analizuje tylko typy widoczne zewnętrznie, ale można to skonfigurować.

Opis reguły

Przeciążenie operatora umożliwia używanie symboli do reprezentowania obliczeń dla typu. Na przykład typ, który przeciąża symbol + plus dla dodawania, zwykle ma alternatywny element członkowski o nazwie Add. Nazwany element członkowski alternatywny zapewnia dostęp do tej samej funkcjonalności co operator. Jest on dostarczany dla deweloperów, którzy programują w językach, które nie obsługują przeciążonych operatorów.

Ta reguła sprawdza:

  • Niejawne i jawne operatory rzutowane w typie, sprawdzając metody o nazwach To<typename> i From<typename>.

  • Operatory wymienione w poniższej tabeli:

C# Visual Basic C++ Alternatywna nazwa metody
+ (plik binarny) + + (plik binarny) Add
+= += += Add
& And & BitoweAnd
&= And = &= BitoweAnd
| Or | Bitowetor
|= Or = |= Bitowetor
-- Nie dotyczy -- Zmniejszyć
/ / / Podziel
/= /= /= Podziel
== = == Równa się
^ Xor ^ Xor
^= Xor= ^= Xor
> > > CompareTo lub Compare
>= >= >= CompareTo lub Compare
++ Nie dotyczy ++ Przyrost
!= <> != Równa się
<< << << LeftShift
<<= <<= <<= LeftShift
< < < CompareTo lub Compare
<= <= <= CompareTo lub Compare
&& Nie dotyczy && Wartość logiczna
|| Nie dotyczy || Wartość logiczna
! Nie dotyczy ! Wartość logiczna
% Mod % Mod lub Remainder
%= Nie dotyczy %= Mod
* (binarne) * * Razy
*= Nie dotyczy *= Razy
~ Not ~ OneComplement
>> >> >> RightShift
>>= Nie dotyczy >>= RightShift
- (binarne) - (binarne) - (binarne) Subtract
-= Nie dotyczy -= Subtract
prawda Istrue Nie dotyczy IsTrue (Właściwość)
- (jednoargumentowy) Nie dotyczy - Negacja
+ (jednoargumentowy) Nie dotyczy + Plus
fałsz Isfalse Fałsz IsTrue (Właściwość)

*N/A oznacza, że operator nie może być przeciążony w wybranym języku.

Uwaga

W języku C#, gdy operator binarny jest przeciążony, odpowiedni operator przypisania, jeśli istnieje, jest również niejawnie przeciążony.

Jak naprawić naruszenia

Aby naprawić naruszenie tej reguły, zaimplementuj alternatywną metodę dla operatora. Nadaj jej nazwę przy użyciu zalecanej alternatywnej nazwy.

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżenia z tej reguły, jeśli implementujesz bibliotekę udostępnioną. Aplikacje mogą ignorować ostrzeżenie z tej reguły.

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

Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.

[*.{cs,vb}]
dotnet_diagnostic.CA2225.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ć, które części bazy kodu mają być uruchamiane w tej regule.

Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, których dotyczy, lub dla wszystkich reguł w tej kategorii (użycie), do których ma ona zastosowanie. 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órych częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. 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

Przykład

W poniższym przykładzie zdefiniowano strukturę, która narusza tę regułę. Aby poprawić przykład, dodaj metodę publiczną Add(int x, int y) do struktury.

public struct Point
{
    private int x, y;

    public Point(int x, int y)
    {
        this.x = x;
        this.y = y;
    }

    public override string ToString()
    {
        return String.Format("({0},{1})", x, y);
    }

    // Violates rule: OperatorOverloadsHaveNamedAlternates.
    public static Point operator +(Point a, Point b)
    {
        return new Point(a.x + b.x, a.y + b.y);
    }

    public int X { get { return x; } }
    public int Y { get { return x; } }
}