หลักการตั้งชื่อสำหรับเมธอด Java ที่ส่งคืนบูลีน

ฉันชอบใช้เครื่องหมายคำถามต่อท้ายชื่อ method / function ในภาษาอื่น ๆ Java ไม่ยอมให้ฉันทำ วิธีแก้ปัญหาฉันจะตั้งชื่อเมธอดการส่งคืนบูลีนใน Java ได้อย่างไร การใช้is, has, should, canในด้านหน้าของเสียงวิธีการที่ถูกสำหรับบางกรณี มีวิธีที่ดีกว่าในการตั้งชื่อวิธีการดังกล่าวหรือไม่?

เช่น createFreshSnapshot?

การประชุมคือการถามคำถามในนาม

นี่คือตัวอย่างบางส่วนที่สามารถพบได้ใน JDK:

isEmpty()

hasChildren()

ด้วยวิธีนี้ชื่อจะถูกอ่านเหมือนจะมีเครื่องหมายคำถามอยู่ด้านท้าย

คอลเล็กชันว่างเปล่าหรือไม่
Node นี้มีลูกหรือไม่?

และtrueหมายความว่าใช่และfalseหมายความว่าไม่ใช่

หรือคุณสามารถอ่านแบบยืนยัน:

คอลเล็กชันว่างเปล่า
โหนดมีลูก

หมายเหตุ:บางครั้งคุณอาจต้องการที่จะตั้งชื่อบางสิ่งบางอย่างเช่นวิธีการ
createFreshSnapshot?หากไม่มีเครื่องหมายคำถามชื่อหมายความว่าเมธอดควรสร้างสแนปชอตแทนที่จะตรวจสอบเพื่อดูว่าจำเป็นหรือไม่

ในกรณีนี้คุณควรคิดใหม่ว่าคุณกำลังถามอะไรอยู่ สิ่งที่ชอบisSnapshotExpiredคือชื่อที่ดีกว่ามากและบ่งบอกถึงสิ่งที่วิธีการนี้จะบอกคุณเมื่อถูกเรียก การทำตามรูปแบบเช่นนี้ยังช่วยให้การทำงานของคุณบริสุทธิ์มากขึ้นและไม่มีผลข้างเคียง

ถ้าคุณทำการค้นหาของ GoogleสำหรับisEmpty()ใน Java API คุณได้รับจำนวนมากของผล

หากคุณต้องการให้คลาสของคุณเข้ากันได้กับข้อกำหนดJava Beansเพื่อให้เครื่องมือที่ใช้การสะท้อน (เช่นJavaBuilders , JGoodies Binding ) สามารถจดจำตัวรับบูลีนไม่ว่าจะใช้getXXXX()หรือisXXXX()เป็นชื่อวิธีการ จากข้อมูลจำเพาะ Java Beans:

8.3.2 คุณสมบัติบูลีน

นอกจากนี้สำหรับคุณสมบัติบูลีนเราอนุญาตให้เมธอด getter จับคู่รูปแบบ:

public boolean is< PropertyName > ();

เมธอด“ is < PropertyName >” นี้อาจถูกจัดเตรียมแทนเมธอด“ get < PropertyName >” หรืออาจระบุเพิ่มเติมจากเมธอด“ get < PropertyName >” ไม่ว่าในกรณีใดถ้าเมธอด“ is < PropertyName >” มีอยู่สำหรับคุณสมบัติบูลีนเราจะใช้เมธอด“ is < PropertyName >” เพื่ออ่านค่าคุณสมบัติ ตัวอย่างคุณสมบัติบูลีนอาจเป็น:

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

ฉันต้องการโพสต์ลิงก์นี้เนื่องจากอาจช่วยเพิ่มเติมสำหรับคนที่ตรวจสอบคำตอบนี้และกำลังมองหารูปแบบจาวาเพิ่มเติม

แนวทางรูปแบบการเขียนโปรแกรม Java

รายการ "2.13 เป็นคำนำหน้าควรใช้สำหรับตัวแปรบูลีนและวิธีการ" มีความเกี่ยวข้องโดยเฉพาะและแนะนำว่าเป็นคำนำหน้า

คู่มือสไตล์จะแนะนำ:

มีทางเลือกสองสามทางสำหรับคำนำหน้าคือที่เหมาะกับบางสถานการณ์ เหล่านี้จะมี , สามารถและควรคำนำหน้า:

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

หากคุณปฏิบัติตามแนวทางฉันเชื่อว่าจะมีการตั้งชื่อวิธีการที่เหมาะสม:

shouldCreateFreshSnapshot()

สำหรับวิธีการที่อาจล้มเหลวนั่นคือคุณระบุบูลีนเป็นประเภทการส่งคืนฉันจะใช้คำนำหน้าtry:

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

สำหรับกรณีอื่น ๆ ให้ใช้คำนำหน้าเช่นis.. has.. was.. can.. allows....

มาตรฐานใช้isหรือhasเป็นคำนำหน้า ตัวอย่างเช่น,isValidhasChildren

isเป็นสิ่งที่ฉันเจอมากกว่าที่อื่น ๆ สิ่งที่สมเหตุสมผลในสถานการณ์ปัจจุบันเป็นทางเลือกที่ดีที่สุด

ผมอยากจะชี้ให้มุมมองที่แตกต่างกันเกี่ยวกับเรื่องนี้โดยทั่วไปการตั้งชื่อเช่น:

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

โดยที่เหตุผลคือ:

ไม่ดำเนินการบางอย่างแล้ว รายงาน ว่าจะประสบความสำเร็จหรือไม่

ในขณะที่ชื่อเมธอดreturnเป็นจริงbooleanควรชี้ให้การประมวลผลเสร็จสมบูรณ์แทนที่จะเป็นประเภทผลลัพธ์ (บูลีนสำหรับตัวอย่างนี้)

createFreshSnapshotตัวอย่างของคุณดูเหมือนว่าฉันจะเกี่ยวข้องกับมุมมองนี้มากกว่าเพราะดูเหมือนว่าจะหมายถึงสิ่งนี้: สร้างสแนปชอตใหม่จากนั้นรายงานว่าการดำเนินการสร้างสำเร็จหรือไม่ เมื่อพิจารณาถึงเหตุผลแล้วชื่อนี้createFreshSnapshotน่าจะเหมาะกับสถานการณ์ของคุณที่สุด