CA1046:不要多載參考類型上的等號比較運算子

發行項
11/14/2023

屬性	值
規則識別碼	CA1046
標題	不要多載參考類型上的等號比較運算子
類別	設計
修正程式是中斷或非中斷	中斷
預設在 .NET 8 中啟用	No

原因

公用或巢狀公用參考類型會多載相等運算符。

檔案描述

對參考類型而言，等號比較運算子的預設實作 (Implementation) 永遠都是正確的。根據預設，只有當兩項參考都指向相同物件時才會相等。

如何修正違規

若要修正此規則的違規，請移除等號運算符的實作。

隱藏警告的時機

當參考類型的行為與內建實值類型類似時，隱藏此規則的警告是安全的。如果對型別的實例執行加法或減法是有意義的，則實作等號比較運算符並隱藏違規可能是正確的。

隱藏警告

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

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

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

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

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

設定程式代碼以分析

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

包含特定 API 介面

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

包含特定 API 介面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

範例 1

下列範例示範比較兩個參考時的默認行為。

public class MyReferenceType
{
    private int a, b;
    public MyReferenceType(int a, int b)
    {
        this.a = a;
        this.b = b;
    }

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

範例 2

下列應用程式會比較一些參考。

public class ReferenceTypeEquality
{
    public static void Main1046()
    {
        MyReferenceType a = new MyReferenceType(2, 2);
        MyReferenceType b = new MyReferenceType(2, 2);
        MyReferenceType c = a;

        Console.WriteLine("a = new {0} and b = new {1} are equal? {2}", a, b, a.Equals(b) ? "Yes" : "No");
        Console.WriteLine("c and a are equal? {0}", c.Equals(a) ? "Yes" : "No");
        Console.WriteLine("b and a are == ? {0}", b == a ? "Yes" : "No");
        Console.WriteLine("c and a are == ? {0}", c == a ? "Yes" : "No");
    }
}

這個範例會產生下列輸出：

a = new (2,2) and b = new (2,2) are equal? No
c and a are equal? Yes
b and a are == ? No
c and a are == ? Yes

共用方式為