CA2225: Přetížení operátoru mají pojmenované alternativy
| Vlastnost | Hodnota |
|---|---|
| ID pravidla | CA2225 |
| Název | Přetížení operátoru mají pojmenované alternativy |
| Kategorie | Využití |
| Oprava způsobující chybu nebo chybu způsobující chybu | Nenarušující |
| Povoleno ve výchozím nastavení v .NET 8 | No |
Příčina
Byla zjištěna přetížení operátoru a nebyla nalezena očekávaná pojmenovaná alternativní metoda.
Ve výchozím nastavení toto pravidlo sleduje jenom externě viditelné typy, ale dá se konfigurovat.
Popis pravidla
Přetížení operátoru umožňuje použití symbolů k reprezentaci výpočtů pro typ. Například typ, který přetěžuje symbol + plus pro sčítání, by obvykle měl alternativní člen s názvem Add. Pojmenovaný alternativní člen poskytuje přístup ke stejné funkci jako operátor. Poskytuje se vývojářům, kteří programují v jazycích, které nepodporují přetížené operátory.
Toto pravidlo zkoumá:
Implicitní a explicitní operátory přetypování typu kontrolou metod pojmenovaných
To<typename>aFrom<typename>.Operátory uvedené v následující tabulce:
| C# | Visual Basic | C++ | Alternativní název metody |
|---|---|---|---|
| + (binární) | + | + (binární) | Přidat |
| += | += | += | Přidat |
| & | And | & | BitwiseAnd |
| &= | And= | &= | BitwiseAnd |
| | | Nebo | | | BitwiseOr |
| |= | Or= | |= | BitwiseOr |
| -- | – | -- | Snižovat |
| / | / | / | Vydělit |
| /= | /= | /= | Vydělit |
| == | = | == | Se rovná |
| ^ | Xor | ^ | Xor |
| ^= | Xor= | ^= | Xor |
| > | > | > | CompareTo nebo Compare |
| >= | >= | >= | CompareTo nebo Compare |
| ++ | – | ++ | Přírůstek |
| != | <> | != | Se rovná |
| << | << | << | LeftShift |
| <<= | <<= | <<= | LeftShift |
| < | < | < | CompareTo nebo Compare |
| <= | <= | <= | CompareTo nebo Compare |
| && | – | && | Logický a logický |
| || | – | || | Logický operátor |
| ! | – | ! | Logický uzel |
| % | Mod | % | Mod nebo zbytek |
| %= | – | %= | Mod |
| * (binární) | * | * | Krát |
| *= | – | *= | Krát |
| ~ | Not | ~ | Funkce OnesComplement |
| >> | >> | >> | RightShift |
| >>= | – | >>= | RightShift |
| - (binární) | - (binární) | - (binární) | Subtract |
| -= | – | -= | Subtract |
| true | IsTrue | – | IsTrue (vlastnost) |
| - (unární) | – | - | Negovat |
| + (unární) | – | + | Kladný |
| false (nepravda) | IsFalse | False | IsTrue (vlastnost) |
*Není k dispozici, znamená to, že operátor nelze přetížit ve vybraném jazyce.
Poznámka:
V jazyce C# je při přetížení binárního operátoru také implicitně přetížen odpovídající operátor přiřazení.
Jak opravit porušení
Chcete-li opravit porušení tohoto pravidla, implementujte alternativní metodu operátoru. Pojmenujte ho pomocí doporučeného alternativního názvu.
Kdy potlačit upozornění
Pokud implementujete sdílenou knihovnu, nepotlačujte upozornění z tohoto pravidla. Aplikace můžou ignorovat upozornění z tohoto pravidla.
Potlačení upozornění
Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.
#pragma warning disable CA2225
// The code that's violating the rule is on this line.
#pragma warning restore CA2225
Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.
[*.{cs,vb}]
dotnet_diagnostic.CA2225.severity = none
Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.
Konfigurace kódu pro analýzu
Pomocí následující možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.
Tuto možnost můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (použití), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.
Zahrnutí konkrétních povrchů rozhraní API
Na základě přístupnosti můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:
dotnet_code_quality.CAXXXX.api_surface = private, internal
Příklad
Následující příklad definuje strukturu, která porušuje toto pravidlo. Pokud chcete příklad opravit, přidejte do struktury veřejnou Add(int x, int y) metodu.
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; } }
}
