CA1725: Parametre adları temel bildirim ile eşleşmelidir

Özellik Değer
Kural Kimliği CA1725
Başlık Parametre adları temel bildirimle eşleşmemelidir
Kategori Adlandırma
Düzeltme bozucu ya da bozmayan olabilir Son Dakika
.NET 10'da varsayılan olarak etkin Hayır
Geçerli diller C# ve Visual Basic

Neden

Yöntem geçersiz kılmadaki bir parametrenin adı, yöntemin temel bildirimindeki parametre adıyla veya yöntemin arabirim bildirimindeki parametrenin adıyla eşleşmiyor.

Varsayılan olarak, bu kural yalnızca dışarıdan görünen yöntemlere bakar, ancak bu yapılandırılabilir.

Kural açıklaması

Yöntem geçersiz kılma hiyerarşisinde parametrelerin tutarlı adlandırılması, yöntem geçersiz kılmalarının kullanılabilirliğini artırır. Türetilmiş bir yöntemdeki parametre adının, tabandaki beyana kıyasla farklı olması, yöntemin taban yöntemi geçersiz kılan bir sürüm mü yoksa yeni bir aşırı yükleme mi olduğu konusunda karışıklık yaratabilir.

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için parametresini temel bildirimle eşleşecek şekilde yeniden adlandırın. Düzeltme, parametre adını belirten arayanlar için uyumsuzluk yaratan bir değişikliktir.

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();
    }
}

Uyarıların ne zaman bastırılması gerekiyor?

Daha önce gönderilen kitaplıklardaki görünür yöntemler dışında bu kuraldan gelen bir uyarıyı gizlemeyin.

Uyarıyı gizleme

Yalnızca tek bir ihlali engellemek istiyorsanız, kuralı devre dışı bırakmak ve sonra yeniden etkinleştirmek için kaynak dosyanıza ön işlemci yönergeleri ekleyin.

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

Bir dosya, klasör veya projenin kuralını devre dışı bırakmak için, yapılandırma dosyasındaki önem derecesini noneolarak ayarlayın.

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

Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.

Kod çözümleme için konfigüre et

Bu kuralın kod tabanınızın hangi bölümlerinde çalıştırılacaklarını yapılandırmak için aşağıdaki seçeneği kullanın.

Bu seçeneği yalnızca bu kural, geçerli olduğu tüm kurallar veya bu kategorideki (Adlandırma) tüm kurallar için yapılandırabilirsiniz. Daha fazla bilgi için bkz . Kod kalitesi kuralı yapılandırma seçenekleri.

Belirli API yüzeylerini ekleme

api_surface seçeneğini ayarlayarak, bu kuralın erişilebilirliği temelinde kod tabanınızın hangi bölümlerinde çalıştırılacaklarını yapılandırabilirsiniz. Örneğin, kuralın yalnızca genel olmayan API yüzeyinde çalıştırılması gerektiğini belirtmek için projenizdeki bir .editorconfig dosyasına aşağıdaki anahtar-değer çiftini ekleyin:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Not

XXXX CAXXXX bölümünü geçerli kuralın kimliğiyle değiştirin.