Quy ước đặt tên cho các phương thức java trả về boolean (Không có dấu chấm hỏi)

Tôi thích sử dụng dấu chấm hỏi ở cuối tên phương thức / hàm trong các ngôn ngữ khác. Java không cho phép tôi làm điều này. Để giải quyết vấn đề, tôi có thể đặt tên cho các phương thức trả về boolean trong Java như thế nào? Sử dụng một is, has,should , canở phía trước của một âm thanh phương pháp okay cho một số trường hợp. Có cách nào tốt hơn để đặt tên cho các phương thức như vậy không?

Ví dụ: createFreshSnapshot?

Quy ước là đặt một câu hỏi trong tên.

Dưới đây là một số ví dụ có thể được tìm thấy trong JDK:

isEmpty()

hasChildren()

Bằng cách đó, tên được đọc giống như chúng sẽ có một dấu chấm hỏi ở cuối.

Bộ sưu tập có trống không?
Node này có con không?

Và, sau đó, truecó nghĩa là có, và falsecó nghĩa là không.

Hoặc, bạn có thể đọc nó như một khẳng định:

Bộ sưu tập trống.
Nút có con

Lưu ý:
Đôi khi bạn có thể muốn đặt tên một phương thức giống như vậy createFreshSnapshot?. Nếu không có dấu chấm hỏi, tên ngụ ý rằng phương pháp sẽ tạo ra một ảnh chụp nhanh, thay vì kiểm tra xem liệu phương pháp có được yêu cầu hay không.

Trong trường hợp này, bạn nên suy nghĩ lại những gì bạn thực sự đang hỏi. Cái gì đó nhưisSnapshotExpired là một cái tên hay hơn nhiều và truyền đạt những gì phương thức sẽ cho bạn biết khi nó được gọi. Làm theo một mô hình như thế này cũng có thể giúp giữ cho nhiều chức năng của bạn tinh khiết và không có tác dụng phụ.

Nếu bạn làm một Google Search cho isEmpty()trong API Java, bạn nhận được rất nhiều kết quả.

Nếu bạn muốn lớp của mình tương thích với đặc tả Java Beans , để các công cụ sử dụng phản xạ (ví dụ: JavaBuilders , JGoodies Binding ) có thể nhận ra bộ lấy boolean, sử dụng getXXXX()hoặc isXXXX()dưới dạng tên phương thức. Từ thông số Java Beans:

8.3.2 Thuộc tính Boolean

Ngoài ra, đối với thuộc tính boolean, chúng tôi cho phép một phương thức getter khớp với mẫu:

public boolean is<Tên tài sản >() ;

Phương thức “is < PropertyName >” này có thể được cung cấp thay vì phương thức “get < PropertyName >” hoặc nó có thể được cung cấp ngoài phương thức “get < PropertyName >”. Trong cả hai trường hợp, nếu phương thức “is < PropertyName >” hiện diện cho một thuộc tính boolean thì chúng tôi sẽ sử dụng phương thức “is < PropertyName >” để đọc giá trị thuộc tính. Một thuộc tính boolean mẫu có thể là:

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

Tôi muốn đăng liên kết này vì nó có thể giúp ích hơn nữa cho những người xem kiểm tra câu trả lời này và tìm kiếm thêm quy ước kiểu java

Nguyên tắc về kiểu lập trình Java

Mục "2.13 là tiền tố nên được sử dụng cho các biến và phương thức boolean." có liên quan cụ thể và gợi ý tiền tố is .

Hướng dẫn phong cách tiếp tục đề xuất:

Có một số lựa chọn thay thế cho tiền tố is phù hợp hơn trong một số trường hợp. Đây là các tiền tố có , có thể và nên :

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

Nếu bạn tuân theo Nguyên tắc, tôi tin rằng phương pháp thích hợp sẽ được đặt tên là:

shouldCreateFreshSnapshot()

Đối với các phương thức có thể không thành công, tức là bạn chỉ định boolean làm kiểu trả về, tôi sẽ sử dụng tiền tố try:

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

Đối với tất cả các trường hợp khác, hãy sử dụng các tiền tố như is.. has.. was.. can.. allows....

Tiêu chuẩn là sử dụng 'is' hoặc 'has' làm tiền tố. Ví dụ isValid, hasChildren.

islà một trong những tôi đã xem qua nhiều hơn bất kỳ khác. Mặc dù vậy, bất cứ điều gì có ý nghĩa trong tình hình hiện tại là lựa chọn tốt nhất.

Tôi muốn đưa ra một quan điểm khác về quy ước đặt tên chung này , ví dụ:

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

cơ sở lý luận là ở đâu:

thực hiện một số xử lý sau đó báo cáo xem nó có thành công hay không .

Trong khi returnthực sự là một booleanphương thức, tên của phương thức phải chỉ ra quá trình hoàn tất thay vì kiểu kết quả (boolean cho ví dụ này).

createFreshSnapshotĐối với tôi, ví dụ của bạn có vẻ liên quan nhiều hơn đến quan điểm này vì dường như có nghĩa là: tạo một ảnh chụp nhanh mới sau đó báo cáo xem thao tác tạo có thành công hay không. Xem xét lý do này, tên createFreshSnapshotcó vẻ là tốt nhất cho tình huống của bạn.