CA1725: Parametre adları taban yöntem ile eşleşmelidir

  • Makale
Özellik Değer
Kural Kimliği CA1725
Başlık Parametre adları temel bildirimle eşleşmemelidir
Kategori Adlandırma
Hataya neden olan veya bozulmayan düzeltme Yeni
.NET 8'de varsayılan olarak etkin Hayır

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ı

Parametreyi geçersiz kılma hiyerarşisinde tutarlı adlandırma yöntemini geçersiz kılmaları kullanılabilirliği artırır. Temel bildirim alanındaki addan farklı türetilmiş yöntem parametre adı taban yöntemini geçersiz kılma veya yeni aşırı yöntemin yöntem olup olmadığı hakkında karışıklığa neden olabilir.

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için parametresini temel bildirimle eşleşecek şekilde yeniden adlandırın. Düzeltme, COM görünür yöntemleri için hataya neden olan bir değişikliktir.

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

Daha önce gönderilen kitaplıklardaki COM görünür yöntemleri 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.

Çözümlemek için kod yapılandırma

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

Bu kuralın üzerinde çalıştırılacak kod tabanınızın hangi bölümlerini erişilebilirliklerine göre 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