CA2225: Operatorüberladungen weisen benannte Alternativen auf.
| Eigenschaft | Wert |
|---|---|
| Regel-ID | CA2225 |
| Titel | Operatorüberladungen weisen benannte Alternativen auf. |
| Kategorie | Verwendung |
| Fix führt oder führt nicht zur Unterbrechung | Nicht unterbrechend |
| Standardmäßig in .NET 8 aktiviert | Nein |
Ursache
Es wurde eine Operatorüberladung erkannt, und die entsprechend erwartete Alternativmethode wurde nicht gefunden.
Standardmäßig werden mit dieser Regel nur extern sichtbare Typen überprüft, aber dies ist konfigurierbar.
Regelbeschreibung
Die Operatorüberladung ermöglicht die Verwendung von Symbolen zur Darstellung von Berechnungsergebnissen für einen Typ. Beispielsweise würde ein Typ, der das Pluszeichen + zum Hinzufügen überlädt, normalerweise einen alternativen Member mit dem Namen Add aufweisen. Der entsprechende alternative Member bietet Zugang zur gleichen Funktionalität wie der Operator. Dies steht Entwicklern zur Verfügung, die in Sprachen programmieren, die keine überladenen Operators unterstützen.
Diese Regel untersucht:
Implizite und explizite Umwandlungs-Operatoren in einem Typ durch Überprüfung auf Methoden mit dem Namen
To<typename>undFrom<typename>.Die in der folgenden Tabelle aufgeführten Operatoren:
| C# | Visual Basic | C++ | Name alternative Methode |
|---|---|---|---|
| + (binär) | + | + (binär) | Hinzufügen |
| += | += | += | Hinzufügen |
| & | Und | & | BitwiseAnd |
| &= | Und= | &= | BitwiseAnd |
| | | oder | | | BitwiseOr |
| |= | Oder= | |= | BitwiseOr |
| -- | – | -- | Dekrement |
| / | / | / | Dividieren |
| /= | /= | /= | Dividieren |
| == | = | == | Equals |
| ^ | Xor | ^ | Xor |
| ^= | Xoder= | ^= | Xor |
| > | > | > | VergleichenMit oder Vergleichen |
| >= | >= | >= | VergleichenMit oder Vergleichen |
| ++ | – | ++ | Increment |
| != | <> | != | Equals |
| << | << | << | LinksUmschalttaste |
| <<= | <<= | <<= | LinksUmschalttaste |
| < | < | < | VergleichenMit oder Vergleichen |
| <= | <= | <= | VergleichenMit oder Vergleichen |
| && | N/V | && | LogicalAnd |
| || | – | || | LogischOder |
| ! | – | ! | LogischNein |
| % | Mod | % | Mod oder Restwert |
| %= | – | %= | Mod |
| * (binär) | * | * | Multiplizieren |
| *= | – | *= | Multiplizieren |
| ~ | Not | ~ | OnesComplement |
| >> | >> | >> | RechtsUmschalttaste |
| >>= | – | >>= | RechtsUmschalttaste |
| - (binär) | - (binär) | - (binär) | Subtrahieren |
| -= | – | -= | Subtrahieren |
| true | IsTrue | – | IstWahr (Eigenschaft) |
| - (unär) | – | - | Negate |
| + (unär) | – | + | Plus |
| false | IsFalse | Falsch | IstWahr (Eigenschaft) |
*N/A bedeutet, dass der Operator nicht in der ausgewählten Sprache überladen werden kann.
Hinweis
Wenn in C# ein binärer Operator überladen ist, wird der zugehörige Zuweisungsoperator, sofern er vorhanden ist, auch implizit überladen.
Behandeln von Verstößen
Um einen Verstoß gegen diese Regel zu beheben, implementieren Sie die alternative Methode für den Operator. Benennen Sie diese mithilfe des empfohlenen Alternativnamens.
Wann sollten Warnungen unterdrückt werden?
Unterdrücken Sie keine Warnung aus dieser Regel, wenn Sie eine freigegebene Bibliothek implementieren. Anwendungen können eine Warnung aus dieser Regel ignorieren.
Unterdrücken einer Warnung
Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.
#pragma warning disable CA2225
// The code that's violating the rule is on this line.
#pragma warning restore CA2225
Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.
[*.{cs,vb}]
dotnet_diagnostic.CA2225.severity = none
Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.
Konfigurieren des zu analysierenden Codes
Mithilfe der folgenden Option können Sie konfigurieren, für welche Teile Ihrer Codebasis diese Regel ausgeführt werden soll.
Sie können diese Optionen nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Verwendung) konfigurieren. Weitere Informationen finden Sie unter Konfigurationsoptionen für die Codequalitätsregel.
Einschließen bestimmter API-Oberflächen
Sie können je nach Zugänglichkeit festlegen, für welche Bestandteile Ihrer Codebasis diese Regel ausgeführt wird. Sie können beispielsweise festlegen, dass die Regel nur für die nicht öffentliche API-Oberfläche ausgeführt werden soll, indem Sie einer EDITORCONFIG-Datei in Ihrem Projekt das folgende Schlüssel-Wert-Paar hinzufügen:
dotnet_code_quality.CAXXXX.api_surface = private, internal
Beispiel
Im folgenden Beispiel wird eine Struktur definiert, die gegen diese Regel verstößt. Fügen Sie der Struktur eine öffentliche Add(int x, int y) Methode hinzu, um das Beispiel zu korrigieren.
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; } }
}
