CA1066: Menerapkan IEquatable saat menimpa Equals

Properti Nilai
ID Aturan CA1066
Judul Terapkan IEquatable saat menimpa metode Equals
Kategori Desain
Perbaikan bersifat merusak atau tidak merusak Tidak terputus
Diaktifkan secara default di .NET 10 Tidak.
Bahasa yang berlaku C# dan Visual Basic

Penyebab

Jenis nilai (struct) melakukan penimpaan pada metode Equals, tetapi tidak mengimplementasikan IEquatable<T>.

Deskripsi aturan

Metode Equals pada tipe nilai yang di-override menunjukkan bahwa metode ini mendukung perbandingan dua instance dari tipe tersebut untuk kesetaraan nilai. Pertimbangkan untuk mengimplementasikan antarmuka IEquatable<T> untuk mendukung pengujian kesetaraan berjenis kuat. Ini memastikan bahwa penelepon yang melakukan pemeriksaan kesetaraan memanggil metode yang diketik System.IEquatable<T>.Equals dengan kuat dan menghindari tinju argumen, meningkatkan performa. Untuk informasi selengkapnya, lihat Catatan untuk pelaksana.

Implementasi Anda System.IEquatable<T>.Equals harus mengembalikan hasil yang konsisten dengan Equals.

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran, terapkan IEquatable<T> dan perbarui penimpaan Equals untuk menjalankan metode yang sudah diterapkan ini. Misalnya, dua cuplikan kode berikut menunjukkan pelanggaran aturan dan cara memperbaikinya:

public struct S
{
    private readonly int _value;
    public S(int f)
    {
        _value = f;
    }

    public override int GetHashCode()
        => _value.GetHashCode();

    public override bool Equals(object other)
        => other is S otherS && _value == otherS._value;
}

using System;

public struct S : IEquatable<S>
{
    private readonly int _value;
    public S(int f)
    {
        _value = f;
    }

    public override int GetHashCode()
        => _value.GetHashCode();

    public override bool Equals(object other)
        => other is S otherS && Equals(otherS);

    public bool Equals(S other)
        => _value == other._value;
}

Kapan harus menekan peringatan

Aman untuk menekan pelanggaran dari aturan ini jika desain dan keuntungan performa dari menerapkan antarmuka tidak penting.

Menyembunyikan peringatan

Jika Anda hanya ingin menyembunyikan satu pelanggaran, tambahkan arahan praprosedur ke file sumber Anda untuk dinonaktifkan lalu aktifkan kembali aturannya.

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

Untuk menonaktifkan aturan untuk file, folder, atau proyek, atur tingkat keparahannya ke none dalam file konfigurasi.

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Lihat juga

  • Last updated on