CA1710: Tanımlayıcıların sonekleri doğru olmalıdır
TürAdı |
IdentifiersShouldHaveCorrectSuffix |
CheckId |
CA1710 |
Kategori |
Microsoft.Naming |
Bozan Değişiklik |
Bozan |
Sebep
Bir tanımlayıcı doğru son eke sahip değildir.
Kural Tanımı
Kural gereği, belli uzatılan tiplerin isimleri ya da belli arayüzlerin uygulanması, ya da bu tiplerden türetilen türler, basit tip ya da arayüzden oluşturulan son eke sahiptir.
Adlandırma kuralları, hedeflenen ortak dil çalışma zamanı kitaplıkları için ortak bir görünüm sağlar.Bu yeni yazılım kitaplıkları için gerekli olan öğrenme eğrisini azaltır ve müşterinin, kitaplığın yönetilen kodda uzman biri tarafından geliştirildiğine dair güvenini artıtır.
Temel türler ve soneklerle ilişkili arayüzler arağıdaki tabloda listelenmektedir.
Temel tür/Arabirim |
Son Ek |
|---|---|
Öznitelik |
|
EventArgs |
|
Özel Durum |
|
Koleksiyon |
|
Sözlük |
|
Koleksiyon |
|
Koleksiyon veya Sıra |
|
Koleksiyon veya Yığın |
|
Koleksiyon |
|
Sözlük |
|
DataSet |
|
Koleksiyon ya da DataTable |
|
Stream |
|
İzin |
|
Koşul |
|
Bir olay işletici temsilcisi. |
EventHandler |
ICollection uygulanmış türler ve sözlük, yığın veya sıra gibi veri yapılarının genel hali türe yönelik kullanım hakkında anlamlı bilgi sağlayan isimlerin kullanımına izin verirler.
ICollection uygulanmış türler ve belirli öğeler 'Collection' kelimesiyle biten isimlere sahiptir.Örneğin, bir Queue nesneler koleksiyonu 'QueueCollection' adına sahiptir.'Collection' son eki foreach (For Each, Visual Basic) ifadesi kullanılarak koleksiyon üyelerinin numaralandırılacağını ifade eder.
IDictionary uygulanmış türler IEnumerable veya ICollection ile uygulanmış olsa bile 'Dictionary' kelimesiyle biten isimlere sahiptir.'Collection' ve 'Dictionary' son ek adlandırma kuralları kullanıcıların aşağıdaki iki numaralandırma deseni arasında ayrım yapmalarını sağlar.
'Collection' son ekli türler bu numaralandırma desenini izler.
foreach(SomeType x in SomeCollection) { }
'Dictionary' son ekli türler bu numaralandırma desenini izler.
foreach(SomeType x in SomeDictionary.Values) { }
Bir DataSet nesnesi DataTable nesnelerinin koleksiyonundan oluşur, bu da DataColumn ve DataRow nesnelerinin koleksiyonundan oluşur.Bu koleksiyonlar ICollectionInternalDataCollectionBase sınıf temeli aracılığıyla uygulanır.
İhlallerin Düzeltilmesi
Doğru terimle son eklenmesi için türü yeniden adlandırın.
Uyarılar Ne Zaman Bastırılmalı
'Collection' son eki genişletilmiş veya rastgele çeşitli öğeler kümesini tutan genelleştirilmiş bir veri yapısında kullanılmışsa bu kuralı bastırmak güvenlidir.Bu durumda, uygulanma, performans ve veri yapısının diğer özellikleri hakkında anlamlı bilgiler sağlayan isim anlamlıdır (örneğin BinaryTree).Belirli bir türün koleksiyonunu (örneğin StringCollection) gösteren durumlarda, uyarıyı bastırın çünkü oradaki son ek türün foreach ifadesi kullanılarak numaralandırılabileceğini gösterir.
Diğer son ekler için, bu kuralı bastırmayın.Son ek tür adının belirgin olması öngörülen kullanıma izin verir.
İlgili Kurallar
CA1711: Tanımlayıcıların sonekleri yanlış olmamalıdır