CA1046:不要对引用类型重载相等运算符

项目
11/15/2023

属性	值
规则 ID	CA1046
标题	不要对引用类型重载相等运算符
类别	设计
修复是中断修复还是非中断修复	重大
在 .NET 9 中默认启用	否

原因

公共引用类型或嵌套公共引用类型重载相等运算符。

规则说明

对于引用类型，相等运算符的默认实现几乎始终是正确的。默认情况下，仅当两个引用指向同一对象时，它们才相等。

如何解决冲突

若要解决此规则的冲突，请删除相等运算符的实现。

何时禁止显示警告

当引用类型的行为与内置值类型相同时，可禁止显示此规则的警告。如果对该类型的实例执行加法或减法有意义，则实现相等运算符并禁止显示此冲突可能正确。

抑制警告

如果只想抑制单个冲突，请将预处理器指令添加到源文件以禁用该规则，然后重新启用该规则。

#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

通过