Boole döndüren Java yöntemleri için adlandırma kuralları

Diğer dillerde yöntem / işlev adlarının sonunda soru işareti kullanmayı seviyorum. Java bunu yapmama izin vermiyor. Geçici bir çözüm olarak, Java'da boole döndürme yöntemlerini başka nasıl adlandırabilirim? Bir kullanarak is, has, should, canbazı durumlar için tamam bir yöntem sesin önünde. Bu tür yöntemleri adlandırmanın daha iyi bir yolu var mı?

Örneğin createFreshSnapshot?

Sözleşme isimde bir soru sormaktır.

JDK'da bulunabilecek birkaç örnek:

isEmpty()

hasChildren()

Bu şekilde isimler, sonunda soru işareti olacakmış gibi okunur.

Koleksiyon boş mu?
Bu Düğümün çocukları var mı?

Ve o zaman trueevet falsedemek ve hayır demek.

Veya bunu bir iddia gibi okuyabilirsiniz:

Koleksiyon boş.
Düğümün çocukları var

Not:
Bazen bir yöntemi şöyle adlandırmak isteyebilirsiniz createFreshSnapshot?. Soru işareti olmadan ad, yöntemin gerekli olup olmadığını kontrol etmek yerine bir anlık görüntü oluşturması gerektiğini ifade eder.

Bu durumda aslında ne sorduğunuzu yeniden düşünmelisiniz. Gibi isSnapshotExpiredbir şey çok daha iyi bir isimdir ve çağrıldığında yöntemin size ne söyleyeceğini aktarır. Bunun gibi bir model izlemek, işlevlerinizin çoğunu saf ve yan etkisiz tutmanıza da yardımcı olabilir.

Bir yaparsanız Google Araması için isEmpty()Java API, çok sayıda sonuç almak.

Yansımayı kullanan araçların (örneğin JavaBuilders , JGoodies Binding ) boole alıcılarını tanıyabilmesi için sınıfınızın Java Beans belirtimiyle uyumlu olmasını istiyorsanız , ya kullanın ya da bir yöntem adı olarak. Java Beans spesifikasyonundan:getXXXX()isXXXX()

8.3.2 Boole özellikleri

Ek olarak, boole özellikleri için, bir alıcı yönteminin modelle eşleşmesine izin veririz:

public boolean is< ÖzellikAdı > ();

Bu “<olduğunu PropertyName yöntem yerine” get <ait sağlanabilir> “ PropertyName >” yöntemiyle ya da bir “almak <ilaveten sağlanabilir PropertyName >” yöntemiyle. Her iki durumda da, bir boole özelliği için "is < PropertyName >" yöntemi mevcutsa , özellik değerini okumak için "is < PropertyName >" yöntemini kullanacağız. Örnek bir boole özelliği şöyle olabilir:

public boolean isMarsupial();
public void setMarsupial(boolean m);

Bu yanıtı kontrol eden ve daha fazla java tarzı kural arayan kişiler için daha fazla yardımcı olabileceği için bu bağlantıyı göndermek istiyorum.

Java Programlama Stili Yönergeleri

"2.13 , boole değişkenleri ve yöntemleri için önek kullanılmalıdır." özellikle ilgilidir ve is önekini önerir .

Stil rehberi şunları önermeye devam ediyor:

Bazı durumlarda daha iyi uyan is önekine birkaç alternatif vardır . Bunlar has , can ve should prefixes:

boolean hasLicense();
boolean canEvaluate();
boolean shouldAbort = false;

Yönergeleri izlerseniz, uygun yöntemin adlandırılacağına inanıyorum:

shouldCreateFreshSnapshot()

Başarısız olabilecek yöntemler için, yani dönüş türü olarak boole belirtirseniz, öneki kullanırım try:

if (tryCreateFreshSnapshot())
{
  // ...
}

Diğer tüm durumlar için is.. has.. was.. can.. allows.... gibi önekler kullanın .

Standart kullanım isveya hasönek olarak kullanılır. Örneğin isValid, hasChildren.

isdiğerlerinden daha çok karşılaştığım şey. Mevcut durumda mantıklı olan şey, yine de en iyi seçenektir.

Bu genel adlandırma kuralı hakkında farklı bir bakış açısına işaret etmek istiyorum , örneğin:

bkz. java.util.Set :boolean add​(E e)

mantık nerede:

Bazı sonra işleme yapmak raporu başarılı olup olmadığını .

İken returngerçekten de bir booleanyöntemin adı işaret etmelidir tamamlamak için işleme yerine sonuç türü (bu örnek için boole).

Örneğiniz createFreshSnapshotbenim için bu bakış açısıyla daha ilgili görünüyor çünkü şu anlama geliyor: yeni bir anlık görüntü oluşturun ve ardından yaratma işleminin başarılı olup olmadığını bildirin. Bu mantığı göz önünde bulundurursak, isim createFreshSnapshotdurumunuz için en iyisi gibi görünüyor.