Kısaltmalarla Java Adlandırma Sözleşmesi [kapalı]

Aşağıdaki Java sınıfı için doğru ad nedir: DVDPlayerveya DvdPlayer?

Yanıt Java için tek bir standart olmadığı gibi görünüyor, .NET Framework Tasarım Yönergeleri bunu belirtmek isterim.

Şimdi konu dışı olduğum için beni çarpmadan önce, Java ve .NET Framework için sınıf adlandırma yönergelerinin oldukça benzer olduğunu unutmayın, bu da .NET yönergelerini ikna edici bir referans olarak yararlı kılar.

Genel kurallar

Her iki kılavuz da yalnızca kısaltma yaygın olarak bilindiği ve iyi anlaşıldığı zaman kısaltmaların kullanılmasını önermektedir. DVD veya XML bunun mükemmel örnekleridir, çünkü bunları hemen tanıyacak olsanız da, genişletilmiş sürümü tanımak biraz daha uzun sürer.

Kısaltmalar

.NET Framework Yönergeleri, tanımlayıcılarda yaygın olarak kullanılan iki 'ID' ve 'OK' kısaltmasının kullanılabilmesi dışında kısaltmaların (kısaltmaların aksine) kullanılmamasını önerir. Bir kısaltma Idkullanıldığında, bir camelCase tanımlayıcısının ilk sözcüğü (PascalCase tanımlayıcısının aksine) dışında her zaman karışık durum kullanılır.

Java'da bu kural sadece bir süre takip edilir. Bir göz atın yazımlar karışık nasıl getIDve getIdJCL içindedir. (Sayfayı aşağıya doğru kaydırın). In Java 8 sürümü olsa da, getIdPascalCase kongre günümüzde tercih edilir ima hangi, daha fazla kullanılır. Mümkün olduğunda kısaltmalardan tamamen kaçınmak en iyisidir.

Kısa Kısaltmalar

.NET Framework Yönergeleri, 'IO' gibi iki harfli kısaltmaların her iki harf için de aynı duruma sahip olması gerektiğini söylüyor. PascalCase tanımlayıcıları için (bir sınıf adı gibi), bir camelCase tanımlayıcısı için ( DBRateyerel bir değişken gibi) sahip olabilirsiniz ioChannel.

Bu kesinlikle Java'da geçerli bir kongre gibi görünüyor.

Uzun Kısaltmalar

.NET Framework yönergeleri, bir camelCase tanımlayıcısının ilk sözcüğü haricinde, üç harf veya daha uzun kısaltmaların PascalCase ve camelCase tanımlayıcıları için karışık harf kullanmasını önerir. Bu nedenle, bir sınıf adı XmlDocumentiçin yerel bir değişken adlandırılmış olabilir httpRequest.

Bu kural her zaman Java ile uygulanmaz. Dört karakterli kısaltmalar genellikle karışık harf kullanıyor gibi görünmektedir, ancak JCL bile üç harfli kısaltmalar ile tutarlı değildir. Çoğu 'URL', 'XML', 'SQL' ve 'DOM' gibi büyük harf gibi görünüyor, ancak 'Jar' gibi bazı istisnalar var.

Sonuç

Java için:

4+ harfli kısaltmalar için karışık harf kullanın. Standart kütüphane bunu yapar ve sadece mantıklıdır.

3 harfli kısaltmalar için JCL gibi tüm büyük harfleri kullanabilir veya .NET Framework'ün yaptığı gibi karışık harf kullanabilirsiniz. Her iki durumda da tutarlı olun.

2 harfli kısaltmalar için tüm büyük harfleri kullanın.

2 harfli kısaltmalar için Java'nın gerçekten bir standardı yoktur, ancak diğer isimlerle tutarlılık tüm büyük harflerin daha iyi görünmesini sağlamadığı sürece karışık bir durum kullanmanızı öneririm.

"Doğru" cevap yok. Diğer araçlarınızla daha iyi oynayan bir dizi uygulama ve kongre.

Bu yüzden tercih ederim DvdPlayer. Eclipse'de her kelimenin ilk harfine göre Ctrl+ Shift+ Tve sınıf seçebileceğinizden daha yararlıdır .

İkisini de vahşi doğada kullandıklarını gördüm ve Güneş bu DVDPlayertarzın peşinde. DvdPlayerYine de tercih ederim , çünkü bu şekilde olduğu gibi ardışık çoklu kısaltmalar olsa bile kelime sınırlarının nerede olduğu açıktır HTTPURLConnection.

Sınıfların bireysel örneklerini aşağıdaki şekilde tanımlamayı seviyorum:

Catalogue catalogue;
Person person;

Bu nedenle, eğer kullansaydım DVDPlayer, bunun bir örneği ne derdim? dVDPlayer? Bu yüzden DvdPlayersınıf adını seçerdim , böylece örneklere isim verebilirsiniz dvdPlayer.

JavaSE sınıflarından, apache ortak alanlarından ve ilkbahardan bazı örnekler:

• HttpURLConnection
• HTTPAddress
• UrlPathHelper
• AopProxy
• ISBNValidator

Yani - önemli değil.

Etkili Java DvdPlayer'ı tercih ediyor gibi görünüyor.

Diğerlerinin de belirttiği gibi, projeler arasında farklılık gösteren stil bir şey. Guava ve GWT gibi Google projeleri DvdPlayerstili tercih ediyor .

https://google.github.io/styleguide/javaguide.html#s5.3-camel-case

Gönderen güneş java docs :

Sınıf isimleri, her bir iç kelimenin ilk harfinin büyük harflerle yazılmasıyla isimler olmalıdır. Sınıf adlarınızı basit ve açıklayıcı tutmaya çalışın. Tam kelimeler kullanın-kısaltmalardan ve kısaltmalardan kaçının (kısaltma, URL veya HTML gibi uzun formdan çok daha yaygın olarak kullanılmadıkça).

DVDPlayerstandarttır, ancak DvdPlayernadir değildir.

Sen daha sık görmüyorsun getId. Muhtemelen ID'nin "Kimlik" kısalması olduğunu düşünüyorum. Aslında Kimlik Belgesinin baş harfleri.

HttpURLConnectiongenellikle karışık sözleşmenin bir örneği olarak verilir. Ancak, bir URL'de protokol adı olarak kullanılan "http" küçük harf olmalıdır (büyük harf genellikle kabul edilir).

Burada "doğru" yoktur, sadece tercihler vardır.

Sun, "URL" ve "HTML" içeren sınıfları adlandırma biçiminde tutarlıdır, ancak javadocs'ta hem tüm büyük harfleri hem de deve durumunu kullanarak HTTP'yi görüyorum.

Şahsen, DvdPlayer'ı tercih ederim.