C # ad alanı ve kütüphaneler için sınıf adlandırma kuralı

C # dilinde çeşitli küçük yardımcı program işlevlerine sahip kütüphaneler kuruyorum ve bir ad alanına ve sınıf adlandırma kuralına karar vermeye çalışıyorum. Mevcut organizasyonum şöyle:

Company
Company.TextUtils
    public class TextUtils {...}
Company.MathsUtils
    public class MathsUtils {...}
    public class ArbitraryPrecisionNumber {...}
    public class MathsNotation {...}
Company.SIUnits
    public enum SISuffixes {...}
    public class SIUnits {...}

Bu, ad alanını ve sınıfları düzenlemek için iyi bir yol mu, yoksa daha iyi bir yol var mı? Özellikle ad alanında ve adında aynı ada sahip olmak gibi görünüyor (örneğin, Company.TextUtilsad alanı ve TextUtilssınıf) sadece çoğaltmadır ve şemanın daha iyi olabileceğini düşündürmektedir.

Adlandırma stratejinizin ne kadar etkili olduğunu kodunuzun geri kalanından ayrı tutmak zordur.

Ad alanı, kod tabanınızın geniş yapısına nerede uyduğu konusunda bir fikir vermelidir ve sınıf adı genellikle, bu alanda ne tür işlevsellik veya kavramı temsil ettiğini açıklar.

Belirli bir örnekte, çok daha fazla 'Util' tipi sınıfınız varsa, onları Company.Utils.Mathsvb. Altına almayı düşünebilirsiniz . Bu şekilde, birden fazla kullanım alanına ortak olan işlevler eklemeniz gerekiyorsa, zaten bunun için doğal bir yer.

Microsoft: Framework Tasarım Kuralları'na uymak için izlemeniz gereken birçok kural içeren hoş bir belge var .

Değiştirmek gerektiğini bir şey var: Do not kendi ad olarak sınıflarını adlandırın. Bu derleyici karışımlarına yol açacaktır. Sadece yapma Her iki isim alanı sınıfı için daha iyi bir isim bulun.

C # veya .NET ekosistemi ile çalıştığımdan beri bir süre geçti, o yüzden şu an önerilen en iyi uygulamaların ne olduğunu söyleyemem. İsimlerinizde böyle bir değişiklik yapmanızı tavsiye ederim:

Company
Company.Text
    public class TextUtils {...}
Company.Math
    public class MathUtils {...}
    public class ArbitraryPrecisionNumber {...}
    public class MathsNotation {...}
Company.SI
    public enum SISuffixes {...}
    public class SIUnits {...}

Burada yaptığım şey, isim alanı adlarından "Utils" i kaldırmak. Bence "Util" bir isim alanında olmamalıdır, çünkü Company.Textisim alanı bir gün metin programı dersleri olmayan sınıflar içerebilir . Company.MathAd zaten içeriyor ArbitraryPrecisionNumber, bir "yarar" olarak gözükmüyor hangi.

"Util" i ad alanından kaldırmak aynı adı taşıyan iki şeyden kaynaklanabilecek karışıklığı da giderir (Robert'ın cevabında belirtildiği gibi: /software//a/340440/13156 )

Kodu düzenlemenin bir başka yolu:

Company
Company.Util
    public class TextUtils {...}
    public class MathUtils {...}
Company.Math
    public class ArbitraryPrecisionNumber {...}
    public class MathsNotation {...}
Company.SI
    public enum SISuffixes {...}
    public class SIUnits {...}

Bu durumda, yardımcı sınıfların tümü aynı ad alanında bulunur. Company.TextYardımcı sınıf olduğu için tek isim alanı yok .

Şahsen ilk seçeneği biraz daha net buluyorum.

Ad alanı ve içindeki sınıf için aynı adı kullanmak sorunludur.

• Ad alanı birden fazla sınıf içeriyorsa, neden diğer sınıflar oraya konsun? doğru hissetmiyor, çünkü ad alanının isminin amacı sadece içindeki değil, içindeki tüm sınıfları tanımlamak . Örneğin, bir ad alanında ve sınıflarınız varsa JsonSerialization, ad alanınızı adlandırmak mantıklı olur mu?BinarySerializationXmlSerializationXmlSerialization

  Genelde olan şey, bir sınıfın varolan bir ad alanından çıkarılması veya birden çok sınıf veya başka bir yeniden yapılanma arasında bir birleşme nedeniyle, kendinizi büyük bir sınıf içeren bir ad alanıyla bulmanızdır ; aşamalı olarak, küçük sınıflar oraya yerleştirilir çünkü orjinal sınıfla biraz ilişkilidir. Örneğin, bir ad LogParser, tek bir sınıf içerebilir LogParserve sonra birileri koyar LogConverteroldukça, daha sonra ayrıştırıcı alakalı çünkü LogSearchervb Buradaki sorun ad alanının adı değiştirilmedi şudur: yakında kadar LogConvertereklenmiş, adın, LogsProcessingveya olarak değiştirilmeliydi Logs.

• Ad alanı yalnızca bir sınıf içeriyorsa , kod organizasyonu içindeki bir sorunun işareti olabilir .

  Birkaç kez, uygun SOLID ilkelerine sahip tek bir sınıfın, kod tabanındaki herhangi bir şeyden çok farklı olduğu ve dolayısıyla özel bir ad alanına yerleştirildiği durumları görmeme rağmen, bu tür durumlar nadirdir. Daha sık olarak, bu bir sorunun göstergesidir. Benzer şekilde, hiçbir şey tek bir yöntem içeren bir sınıfa sahip olmanızı engellemez, ancak çoğu zaman bu tür sınıflar bir sorunu işaret eder.

  Ad alanınız yalnızca bir sınıf içeriyor olsa bile, genellikle sınıfı adlandırırken daha belirgin olmanın ve ad alanını adlandırırken daha genel olmanın bir yolu vardır. Belirli bir anda, ABC biçiminde yazılmış dosyaları DEF biçimine dönüştürmesi gereken bir uygulamayı düşünün. Dönüşüm, işletme nesnelerine / işlerinden seri hale getirme / serileştirme gerektirmez ve dönüşüm sınıfının içine konacak kadar kısa olan bir sürü normal ifade uygulayarak yapılır.AbcToDefConverter. Tüm dönüşüm mantığı, yaklaşık on birbirine bağlı yöntemde yaklaşık 80 LLOC alır - var olan sınıfı ayırmaya veya ek sınıflar yaratmaya kesinlikle gerek olmayan bir durum gibi görünüyor. Uygulamanın kalan kısmının dönüşümlerle hiçbir ilgisi olmadığı için, sınıf mevcut ad alanlarında diğer sınıflarla gruplandırılamaz. Böylece biri denilen bir ad alanı yaratır AbcToDefConverter. İçinde yanlış olan hiçbir şey olmamasına rağmen, kişi gibi daha genel bir ad da kullanabilirdi Converters. Python gibi dillerde daha kısa isimlerin tercih edildiği ve tekrarlamanın üzerine atıldığı dillerde bile olabilir converters.Abc_To_Def.

Bu nedenle, ad alanları için içerdikleri sınıflardan farklı adlar kullanın. Bir sınıfın adı, sınıfın ne yaptığını belirtmek zorunda iken, ad alanının adı, içine konulan tüm sınıflarda ortak olanı vurgulamalıdır.

Bu arada, faydalı sınıflar doğası gereği yanlıştır: isteğe bağlı kesin aritmetik gibi belirli bir şey eklemek yerine , diğer sınıflarda yolunu bulamayan her şeyi içerir . Bu, sadece Miscellaneousmasaüstünde bir dizin olarak, organizasyon eksikliğinin göstergesi olan bir şey olarak, kötü adlandırmadır .

Adlandırma bir sebepten dolayı vardır: daha sonra bir şeyler bulmanız gerektiğinde hayatınızı kolaylaştırmak için. Bir grafik çizmeniz gerekirse, “grafik” veya “arsa” aramayı deneyebilirsiniz. Bir uygulamanın fatura oluşturma şeklini değiştirmeniz gerektiğinde, “fatura [e / ing]” veya “fatura” kelimesini ararsınız. Benzer şekilde, kendinize söyleyeceğiniz bir durumu hayal etmeye çalışın: “hm, bu özellik muhtemelen misc ile bulunur”. Yapamam

.NET Framework'e bakın. Bu sınıfların çoğu yardımcı sınıflar değil mi? Demek istediğim, işletme alanıyla ilgili yapacakları çok az şey var. Bir finansal uygulama veya bir e-ticaret web sitesinde veya bir sonraki nesil eğitim platformunda çalışıyorsam, XML'i seri hale getirmek veya dosyaları okumak veya SQL sorguları yapmak veya işlem yapmak hepsi faydalıdır. Ancak, çağrılmazlar UtilitySerializationveya ad alanında UtilityTransactiondeğildirler Utility. İhtiyacım olduğunda onları bulmayı mümkün kılan (ve kolay, .NET geliştiricileri sayesinde!) Uygun isimleri var.

Aynı için geliyor senin yaygın olarak uygulamalarınızda yeniden sınıflar. Onlar faydalı sınıflar değil. Onlar belirli şeyleri yapan sınıflardır ve yaptıkları şeyler aslında sınıfların adları olmalıdır.

Birimlerle ve birimlerin dönüşümüyle ilgili bazı kodlar oluşturduğunuzu hayal edin. Adını verebilir Utilityve meslektaşlarınız tarafından nefret edilebilirsiniz; veya adını Unitsve adını verebilirsiniz UnitsConversion.