CA2225:運算子多載必須有具名的替代方法

  • 發行項
屬性 值
規則識別碼 CA2225
標題 運算子多載必須有具名的替代方法
類別 使用方式
修正程式是中斷或非中斷 不中斷
預設在 .NET 8 中啟用 No

原因

偵測到運算子多載，而且找不到預期的具名替代方法。

根據預設，此規則只會查看外部可見的類型，但這是可設定的。

檔案描述

運算子多載允許使用符號來表示型別的計算。 例如，多載加號加號 + 的類型通常會有一 Add個名為的替代成員。 具名替代成員可讓您存取與運算子相同的功能。 它提供給以不支援多載運算子的語言撰寫程式的開發人員。

此規則會檢查：

  • 藉由檢查名為 To<typename> 和 From<typename>的方法，以在型別中隱含和明確轉換運算符。

  • 下表所列的運算子：

C# Visual Basic C++ 替代方法名稱
+ （二進位） + + （二進位） 加
+= += += 加
& 且 & BitwiseAnd
&= And= &= BitwiseAnd
| Or | BitwiseOr
|= Or= |= BitwiseOr
-- N/A -- 遞減
/ / / 分割
/= /= /= 分割
== = == 等於
^ Xor ^ Xor
^= Xor= ^= Xor
> > > CompareTo 或 Compare
>= >= >= CompareTo 或 Compare
++ N/A ++ [遞增]
!= <> != 等於
<< << << LeftShift
<<= <<= <<= LeftShift
< < < CompareTo 或 Compare
<= <= <= CompareTo 或 Compare
&& N/A && LogicalAnd
|| N/A || LogicalOr
! N/A ! LogicalNot
% Mod % Mod 或餘數
%= N/A %= Mod
* （二進位） * * 乘積
*= N/A *= 乘積
~ Not ~ OnesComplement
>> >> >> RightShift
>>= N/A >>= RightShift
- （二進位） - （二進位） - （二進位） Subtract
-= N/A -= Subtract
true IsTrue N/A IsTrue （屬性）
- （一元） N/A - Negate
+ （一元） N/A + 加
false IsFalse False IsTrue （屬性）

*N/A 表示運算符不能以選取的語言多載。

注意

在 C# 中，當二元運算子多載時，對應的指派運算元，如果有的話，也會隱含多載。

如何修正違規

若要修正此規則的違規，請實作 運算子的替代方法。 使用建議的替代名稱命名它。

隱藏警告的時機

如果您要實作共享連結庫，請勿隱藏此規則的警告。 應用程式可以忽略此規則的警告。

隱藏警告

如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

#pragma warning disable CA2225
// The code that's violating the rule is on this line.
#pragma warning restore CA2225

若要停用檔案、資料夾或項目的規則，請在組態檔中將其嚴重性設定為 。none

[*.{cs,vb}]
dotnet_diagnostic.CA2225.severity = none

如需詳細資訊，請參閱 如何隱藏程式代碼分析警告。

設定程式代碼以分析

使用下列選項來設定程式代碼基底要執行此規則的部分。

您可以只針對此規則、它套用的所有規則，或針對套用至此類別的所有規則（使用方式）設定這個選項。 如需詳細資訊，請參閱 程式代碼品質規則組態選項。

包含特定 API 介面

您可以根據程式代碼基底的存取範圍，設定要執行此規則的部分。 例如，若要指定規則只應該針對非公用 API 介面執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.api_surface = private, internal

範例

下列範例會定義違反此規則的結構。 若要更正範例，請將公用 Add(int x, int y) 方法新增至 結構。

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; } }
}