Tür Üyelerinin Adları

  • Makale

Not

Bu içerik, Çerçeve Tasarım Yönergeleri: Kurallar, Deyimler ve Yeniden Kullanılabilir .NET Kitaplıkları için Desenler, 2. Sürüm'den Pearson Education, Inc.'in izniyle yeniden yazdırılır. Bu baskı 2008'de yayımlandı ve kitap o zamandan beri üçüncü baskıda tamamen revize edilmiştir. Bu sayfadaki bazı bilgiler güncel olmayabilir.

Türler üyelerden oluşur: yöntemler, özellikler, olaylar, oluşturucular ve alanlar. Aşağıdaki bölümlerde, adlandırma türü üyelerine yönelik yönergeler açıklanmaktadır.

Yöntemlerin Adları

Yöntemler eylem gerçekleştirme aracı olduğundan, tasarım yönergeleri yöntem adlarının fiiller veya fiil tümcecikleri olmasını gerektirir. Bu yönergenin ardından, ad veya sıfat tümcecikleri olan özellik ve tür adlarından yöntem adlarını ayırt etmek de sağlanır.

✔️ DO, yöntemlere fiil veya fiil tümceciği olan adlar verir.

public class String {
    public int CompareTo(...);
    public string[] Split(...);
    public string Trim();
}

Özelliklerin Adları

Diğer üyelerin aksine, özelliklere isim tümceciği veya sıfat adları verilmelidir. Bunun nedeni, bir özelliğin verilere başvuruyor olması ve özelliğin adının bunu yansıtmasıdır. PascalCasing her zaman özellik adları için kullanılır.

✔️ ad, isim tümceciği veya sıfat kullanan DO adı özellikleri.

❌ Aşağıdaki örnekte olduğu gibi "Get" yöntemlerinin adıyla eşleşen özelliklere sahip DEĞİlDİr:

public string TextWriter { get {...} set {...} } public string GetTextWriter(int value) { ... }

Bu desen genellikle özelliğin gerçekten bir yöntem olması gerektiğini gösterir.

✔️ Do name collection properties with a plural phrase with the items in the collection, using a singular tümceciği yerine "List" veya "Collection".

✔️ DO, Boole özelliklerini doğrulayıcı bir tümcecikle (CanSeek yerine CantSeek) adlandırır. İsteğe bağlı olarak, Boole özelliklerini "Is", "Can" veya "Has" ile önek olarak da kullanabilirsiniz, ancak yalnızca değer eklediği yerde.

✔️ Bir özelliğe türüyle aynı adı vermeyi GÖZ ÖNÜNDE BULUNDURUN.

Örneğin, aşağıdaki özellik adlı Colorbir sabit listesi değerini doğru alır ve ayarlar; bu nedenle özelliğin adı Color:

public enum Color {...}
public class Control {
    public Color Color { get {...} set {...} }
}

Olayların Adları

Olaylar her zaman gerçekleşen veya gerçekleşen bir eyleme başvurur. Bu nedenle, yöntemlerde olduğu gibi olaylar fiillerle adlandırılır ve olayın tetiklenme zamanını belirtmek için fiil süresi kullanılır.

✔️ Eylem veya fiil tümceciğiyle OLAYLARı ADLANDıR.

Örnek olarak Clicked, Painting, DroppedDownve benzeri verilebilir.

✔️ DO, mevcut ve geçmiş zamanları kullanarak olay adlarını önce ve sonra kavramıyla birlikte verir.

Örneğin, bir pencere kapatılmadan önce tetiklenen bir kapanış olayı olarak adlandırılır Closingve pencere kapatıldıktan sonra tetiklenen olay olarak adlandırılır Closed.

❌ Ön ve son olayları belirtmek için "Önce" veya "Sonra" ön eklerini veya post düzeltmelerini KULLANMAYIN. Mevcut ve geçmiş zamanları açıklandığı gibi kullanın.

✔️ Aşağıdaki örnekte gösterildiği gibi "EventHandler" soneki ile DO olay işleyicileri (olay türleri olarak kullanılan temsilciler) :

public delegate void ClickedEventHandler(object sender, ClickedEventArgs e);

✔️ DO, ve e adlı sender iki parametreyi olay işleyicilerinde kullanır.

Sender parametresi olayı tetikleyen nesneyi temsil eder. Gönderen parametresi, daha belirli bir tür objectkullanmak mümkün olsa bile genellikle türündedir.

✔️ "EventArgs" soneki ile DO adı olay bağımsız değişken sınıfları.

Alanların Adları

Alan adlandırma yönergeleri statik genel ve korumalı alanlara uygulanır. İç ve özel alanlar yönergeler kapsamında değildir ve genel veya korumalı örnek alanlarına üye tasarım yönergeleri tarafından izin verilmez.

✔️ DO, alan adlarında PascalCasing kullanır.

✔️ ad, isim tümceciği veya sıfat kullanarak DO ad alanları.

❌ Alan adları için ön ek KULLANMAYIN.

Örneğin, statik alanları göstermek için "g_" veya "s_" kullanmayın.

Porsiyonlar © 2005, 2009 Microsoft Corporation. Tüm hakları saklıdır.

Pearson Education, Inc. in Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraryes, 2nd Edition by Krzysztof Cwalina and Brad Abrams izniyle yeniden yazdırıldı ve 22 Ekim 2008'de Addison-Wesley Professional tarafından Microsoft Windows Geliştirme Serisi'nin bir parçası olarak yayımlandı.

Ayrıca bkz.