Cách chính xác để tham khảo các thành viên Java trong văn bản là gì?

Question

Khi trả lời các câu hỏi, tôi tự đề cập đến tên phương thức và tài liệu trực tuyến thường xuyên. Tôi đang bối rối về cách tên phương pháp nên được tham chiếu trong văn bản.

Ví dụ tôi thường gõ:

Người ta phải sử dụng String.equals() cho so sánh hai chuỗi sự bình đẳng.

Tuy nhiên, đây là một chút sai lệch:

1. Nó làm cho equals() xuất hiện là một thành viên tĩnh.
2. Nó làm cho equals() xuất hiện để không nhận bất kỳ đối số nào.

Trong sự quan tâm của compleness, tôi muốn biết:

cách chính xác để tham khảo cả các thành viên tĩnh và các thành viên dụ là gì?

Tôi đã nhìn thấy những thứ như:

• String.equals()
• String # equals()
• myString.equals()

Có cách nào để đề cập đến các phương pháp theo cách đối lập-thuyết bất khả tri?

Ví dụ: trong C foo(void) rõ ràng là hàm 0 đối số và foo() có thể được định nghĩa lại sau để có một bộ đối số khác. (?)

Answer 1

Nếu bạn muốn được thực sự là chính xác mà bạn có thể sử dụng

java.lang.String#equals(java.lang.Object) 

hoặc các hình thức ngắn

String#equals(Object) 

này tương tự với ký hiệu được sử dụng trong javadoc và thú vị cũng trông tương tự để liên kết đến các tài liệu mà kết thúc với:

String.html#equals(java.lang.Object) 

Edit: Dưới đây là một liên kết đến javadoc documentation mô tả làm thế nào để sử dụng tài liệu tham khảo.

Answer 2

Tôi đã tìm thấy liên kết tới tài liệu về phương pháp equals của String loại bỏ sự mơ hồ.

Answer 3

Tôi thường tham chiếu tên lớp và phương thức, với kỳ vọng mà người đọc có thể sử dụng để theo dõi tài liệu. Có lẽ đó là một chút kiêu ngạo. Tôi không biết.

Nếu tôi đang cố gắng đưa ra một điểm về việc chữ ký của một phương thức để sử dụng, tôi thường sẽ cung cấp mã mẫu. Điều này chủ yếu là vì tôi thấy nó dễ dàng hơn việc viết ra mô tả dài tay.

Answer 4

Sử dụng myString.equals() không có ý nghĩa trừ khi bạn nói rõ ràng rằng myString là một thể hiện của String. javadoc sử dụng String # equals() để hầu hết các nhà phát triển có thể đọc và dễ hiểu. Đây sẽ là lựa chọn của tôi.

Answer 5

myString.equals() là hoàn hảo. Nó ngụ ý loại và làm rõ rằng chúng ta đang nói về một thể hiện.

Bạn thậm chí có thể thêm:

myString.equals(aString)

Answer 6

String.equals.

Nếu bạn muốn cung cấp loại đối số String.equals(Object).

Việc thêm dấu ngoặc đơn (equals()) là điều C. Đặc biệt là một điều ANSI C, trong đó hàm no-args sẽ được viết là tostring(void) (Tôi thực sự còn quá trẻ (!) Để nhớ K & R/PCC C). C++ cố định điều đó - vì vậy, () thực sự là một trường khá cũ.

Answer 7

Khi đề cập đến một phương pháp, tôi sử dụng "String.equals()". Điều này là dành cho độc giả của con người, và họ có thể biết những gì bạn đang nói về từ ngữ cảnh. Trong trường hợp nó có thể trở thành khó hiểu, chỉ cần nói "phương pháp String.equals()"

One should use String.equals() for comparing two strings for equality. 

Nghiêm túc, ai sẽ bao giờ bị nhầm lẫn bởi câu này? Vì vậy, đừng lo lắng. Nó chỉ là tiếng Anh, không có trình biên dịch la hét với bạn.