CA1725: Nama parameter harus cocok dengan deklarasi dasar

Properti	Nilai
ID Aturan	CA1725
Judul	Nama parameter harus cocok dengan deklarasi dasar
Golongan	Penamaan
Perbaikan bersifat disruptif atau non-disruptif	Merusak
Diaktifkan secara default di .NET 10	No

Penyebab

Nama parameter dalam penimpaan metode tidak cocok dengan nama parameter dalam deklarasi dasar metode atau nama parameter dalam deklarasi antarmuka metode.

Secara default, aturan ini hanya melihat metode yang terlihat secara eksternal, tetapi ini dapat dikonfigurasi.

Deskripsi aturan

Penamaan parameter yang konsisten dalam hierarki penggantian meningkatkan kegunaan pengantian metode. Nama parameter dalam metode turunan yang berbeda dari nama dalam deklarasi dasar dapat menyebabkan kebingungan tentang apakah metode tersebut merupakan penggantian metode dasar atau overload baru metode tersebut.

Cara memperbaiki pelanggaran

Untuk memperbaiki pelanggaran aturan ini, ganti nama parameter agar sesuai dengan deklarasi dasar. Perbaikannya merupakan perubahan yang memutuskan kompatibilitas bagi penelepon yang menentukan nama parameter.

Example

public interface IUserService
{
    int GetAge(int id);
}

public class UserService : IUserService
{
    // Violates CA1725: Parameter name should match the base declaration ('id')
    // for consistency with IUserService
    public int GetAge(int userId)
    {
        throw new NotImplementedException();
    }
}

Kapan harus menekan peringatan

Jangan menekan peringatan dari aturan ini kecuali untuk metode yang terlihat di pustaka yang sebelumnya telah dikirim.

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 CA1725
// The code that's violating the rule is on this line.
#pragma warning restore CA1725

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

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

Untuk informasi selengkapnya, lihat Cara menyembunyikan peringatan analisis kode.

Mengonfigurasi kode yang akan dianalisis

Gunakan opsi berikut untuk mengonfigurasi bagian mana dari codebase Anda yang akan menjalankan aturan ini.

• Menyertakan permukaan API tertentu

Anda dapat mengonfigurasi opsi ini hanya untuk aturan ini, untuk semua aturan yang berlaku untuknya, atau untuk semua aturan dalam kategori ini (Penamaan) yang diterapkannya. Untuk informasi selengkapnya, lihat Opsi konfigurasi aturan kualitas kode.

Menyertakan permukaan API tertentu

Anda dapat mengonfigurasi bagian basis kode mana yang akan dijalankan aturan ini, berdasarkan aksesibilitasnya, dengan mengatur opsi api_surface. Misalnya, untuk menentukan bahwa aturan hanya boleh dijalankan pada permukaan API non-publik, tambahkan pasangan kunci-nilai berikut ke file .editorconfig di proyek Anda:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Nota

Ganti bagian XXXXCAXXXX dengan ID aturan yang berlaku.