CA2231:在覆寫 ValueType.Equals 上多載等號運算子

  • 發行項
屬性 值
規則識別碼 CA2231
標題 在覆寫 ValueType.Equals 上多載等號運算子
類別 使用方式
修正程式是中斷或非中斷 不中斷
預設在 .NET 8 中啟用 建議

原因

實值型別會 System.Object.Equals 覆寫，但不會實作等號比較運算子。

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

檔案描述

在大部分的程式設計語言中，實作實值型別沒有相等運算子 （==） 的預設實作。 如果您的程式設計語言支援運算子多載，您應該考慮實作等號比較運算子。 其行為應該與 的 Equals 相同。

您無法在等號運算子的多載實作中使用預設的等號運算子。 這樣做會導致堆疊溢位。 若要實作等號運算子，請在實作中使用 Object.Equals 方法。 例如：

If (Object.ReferenceEquals(left, Nothing)) Then
    Return Object.ReferenceEquals(right, Nothing)
Else
    Return left.Equals(right)
End If

if (Object.ReferenceEquals(left, null))
    return Object.ReferenceEquals(right, null);
return left.Equals(right);

如何修正違規

若要修正此規則的違規，請實作等號比較運算子。

隱藏警告的時機

隱藏此規則的警告是安全的;不過，建議您盡可能提供相等運算子。

隱藏警告

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

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

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

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

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

設定程式碼以分析

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

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

包含特定 API 介面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

範例

下列範例會定義違反此規則的類型：

public struct PointWithoutHash
{
    private int x, y;

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

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

    public int X { get { return x; } }

    public int Y { get { return x; } }

    // Violates rule: OverrideGetHashCodeOnOverridingEquals.
    // Violates rule: OverrideOperatorEqualsOnOverridingValueTypeEquals.
    public override bool Equals(object? obj)
    {
        if (obj?.GetType() != typeof(PointWithoutHash))
            return false;

        PointWithoutHash p = (PointWithoutHash)obj;
        return ((this.x == p.x) && (this.y == p.y));
    }
}

另請參閱