C # genel türleri için iyi bir adlandırma kuralı nedir? [kapalı]

Bu soruyu yığın taşması yerine burada sormaya karar verdim çünkü oldukça öznel.

C #, genellikle çok kötü adları ile genel türleri görüyorum. Özellikle, "T" yaygın olarak kullanılmaktadır, ancak tek başına anlamlı bir isim değildir. Örneğin:

class Fruit<T>
{
    T fruit;
}

Bu tipik bir yaklaşım olsa da, herkes buna karşı tavsiye eder mi? Ve eğer öyleyse, genel işlevler ve sınıflar için C # bağlamında genel türler için makul bir adlandırma kuralı ne olurdu?

Önceki örneğimde, genel türün Ther zaman Appleveya gibi bir meyve türü olması gerektiğini varsayalım Orange. Tipi Tyani belki daha iyi bir isim olurdu, bu meyve türü olduğunu çok açık hale getirmek için ihtiyacı FruitTypebiz ile bitirmek böylece:

class Fruit<FruitType>
{
    FruitType fruit;
}

Bu size sadece aradığım şey hakkında bir fikir vermek içindir. Bu sorun için kabul edilebilir bir "temel kural" nedir?

Gerçekten öznel ... ish .
Bazı kişiler ibir for döngüsü değişkeni Tiçin mükemmel bir şekilde geçerli olduğundan , bazıları genel bir sınıftaki bir tür yer tutucusu için mükemmel bir şekilde geçerli olduğunu düşünür .

Ben şahsen bu yaklaşımı benimsiyorum, bu yaygın bir toplantı ve insanlar genellikle ne demek istediğinizi biliyorlar.

Tipin anlamlı olduğu yerde anlamlı bir isim kullanırdım, ancak genellikle T ile başlarım. Son zamanlarda genel bir sözlük sınıfı geliştirdim (sorma) ve beyan

public class Dictionary<TKey, TValue>

Ancak, türlerin aslında anlamsız olduğu bir Tuple gibi bir şey için, aşağıdakileri mükemmel bir şekilde kabul edilebilir buluyorum.

public class Tuple<T1, T2, T3>

Bence haklısın, ama T oldukça standart haline geldi. Muhtemelen eski C ++ zamanlarından ve "T tipi" ifadelerinden kaynaklanmaktadır. Mümkün olduğunca açıklayıcı olmak için iyi bir uygulama olduğunu düşünüyorum, ancak bu özneldir.

Bir önek olarak T'yi seçebilirsiniz, tıpkı birçok insanın arayüzler için I'yi seçtiği gibi. Böylece

class Juice<TFruit> where TFruit...

benim düşünceme göre iyi bir isim olurdu. Çoğu durumda önekleri soneklere tercih ederim, çünkü tökezlerken ne gördüğünüzü hemen belli eder ve Intellisense gibi şeyleri aramak daha kolaydır. UI-Controls için de iyi bir uygulamadır, büyük olasılıkla türü her zaman bilirsiniz (örn. TextBox), ancak verdiğiniz açıklayıcı addan% 100 emin değilseniz.

Bunun olumsuz tarafı, tipin kendisi T ile başladığında kötü görünmesidir. Bu nedenle, genel tipin, aşağıdaki gibi özel durumlarda eklenmesi iyi bir şey olacaktır.

class SomeAlgorithm<TypeT> where TypeT : Type

Lütfen bunun sadece benim görüşüm olduğunu ve son derece öznel olduğunu unutmayın. Ama sanırım son ekin önekini tercih etmekle ilgili küçük bir noktam var.

Microsoft'un jeneriklerle ilgili resmi bir kılavuzu vardır: Sınıfların, Yapıların ve Arayüzlerin Adları ( burada ve kitap biçiminde alıntılanmıştır : Çerçeve Tasarım Yönergeleri ).

Özel sorunuzla ilgili olarak:

Tek harfli bir ad tamamen açıklayıcı değilse ve açıklayıcı bir ad değer katmazsa, genel tür parametrelerini açıklayıcı adlarla yapın.

IDictionary<TKey, TValue> 

bu yönergeyi izleyen arabirime bir örnektir.

Tek harfli bir parametreye sahip türler için tür parametresi adı olarak T harfini kullanmayı düşünün.

Açıklayıcı tip parametre adlarını T harfiyle önek uygulayın.

Parametre adında bir type parametresine yerleştirilen kısıtlamaları belirtmeyi düşünün. Örneğin, ISession ile sınırlandırılmış bir parametreye TSession denilebilir.

Jeneriklerin tüm amacı işlevselliği temsil etmektir - genel sınıf bir şey yapar, argümanı başka bir şey yapar. Ders kitabı örneği genel bir koleksiyon: koleksiyon 'şeyleri' saklar, ancak bunların ne olduğu umurumda değil. Bu nedenle, genel bir ad (sic!) Belirli bir mantığa sahiptir - açıklayıcı olmasını istemiyoruz, çünkü adın "bu genel tür argümanı" dışında açıklanacak hiçbir şey yoktur.T kapsamlı bir şekilde kapsadığı (dikkate alınarak sözleşmesi). Açıklayıcı olmak iyidir, ancak aşırı açıklayıcı olmak, orada olmayan kısıtlamaları önerir.

Bununla birlikte, bazen, genel bir sınıf veya yöntem birden fazla tür parametresine sahiptir ve bu noktada, onlara daha açıklayıcı adlar vermek mantıklıdır, böylece rolleri belirginleşir. Buna iyi bir örnek, hem anahtar hem de değerin genel olduğu bir anahtar / değer toplama türü olabilir; Onları çağıran Tve S(veya Qya da her neyse) diyelim ki, onları çağıran daha az yararlı olabilir, olacaktır KeyTypeve ValueTypeya TKeyve TVal.

Cevap gerçekten özneldir. Bununla birlikte, kodun kendi kendini belgelemesi gerektiği için bir soru olarak değeri vardır ve muhtemelen bunu yapmanın daha iyi yollarını öğrenebiliriz.

Aşağıda öğrendiğim ve takip ettiğim sözleşmeler var:

• Genel tip parametreleri hiçbir zaman somut sınıflarla karıştırılmamalıdır. Bu, genellikle Tne olursa olsun, genellikle ön arayüzler gibi bir önsözü teşvik eder I.

• Bir sınıf veya yöntemdeki tek bir genel tip parametresi genellikle etiketlenmelidir T. Bu, C ++ şablonlarına dayanan, evrensel olarak anlaşılmış bir konudur.

• Aynı sınıf veya yöntem bildirimindeki birden fazla genel tip parametresinin tümü T ile başlamalı, ancak bazı kısa ama anlaşılabilir araçlarla ayırt edilmelidir. TInve TOutörneğin, kuvvetle yazılmış bir genel girdiyi kabul eden ve kuvvetle yazılmış bir genel çıktı üreten bir yöntem için ortak ve iyi anlaşılmış GTP'lerdir.

• Net'in Tuple gibi bir sınıf için veya Func, Predicate ve Action gibi delege türleri gibi birden çok farklılaştırılmış ancak dikkat çekici olmayan türler T1, T2, T3 vb. Olarak etiketlenebilir. Bununla birlikte, "dikkat çekici" GTP bildirimleri / veya çok spesifik tür kısıtlamaları) daha açıklayıcı bir şeye sahip olmalıdır.

• Bir kapsayıcı sınıfın genel türünden farklı olan bir yöntemin tek bir genel türü, bir sınıf veya yöntemdeki birden çok türle ilgili önceki kuralı izleyebilir veya VEYA tür farklı olmaktan farklıysa, farklı bir verilebilir. tek harf, genellikle Uveya V. Bu yine C ++ şablonlarına dayanan bir kuraldır.

• Ne yaparsanız yapın, tutarlı tutun; ikinci sınıf ilkinde iç içe geçmediği sürece ikinci sınıfta ikinci sınıfta kullanım için uygun olmadığında GTP'yi bir sınıf Tve sonraki sınıf için etiketlemeyin .TParamT