Có bất kỳ quy ước đặt hàng phương thức Java nào không? [đóng cửa]

Tôi đã có một lớp học lớn (40 phương pháp hoặc hơn) là một phần của gói tôi sẽ gửi dưới dạng công việc khóa học. Hiện tại, các phương thức này khá lộn xộn về mặt tiện ích công cộng / riêng tư, v.v. và tôi muốn đặt hàng chúng một cách hợp lý. Có một cách tiêu chuẩn để làm điều này? Ví dụ, các trường thông thường được liệt kê trước các phương thức, (các) hàm tạo được liệt kê trước các phương thức khác và getters / setters cuối cùng; Còn các phương pháp còn lại thì sao?

Một số quy ước liệt kê tất cả các phương thức công khai trước, sau đó đến tất cả các phương thức riêng tư - điều đó có nghĩa là dễ dàng tách API khỏi việc triển khai, ngay cả khi không có giao diện liên quan, nếu bạn hiểu ý tôi là gì.

Một ý tưởng khác là nhóm các phương thức liên quan lại với nhau - điều này giúp dễ dàng phát hiện ra các đường nối nơi bạn có thể chia lớp lớn hiện có của mình thành nhiều nhóm nhỏ hơn, nhắm mục tiêu hơn.

1. Biến lớp (tĩnh): Đầu tiên là biến lớp công khai, sau đó là biến được bảo vệ và sau đó là riêng tư.

2. Biến sơ thẩm: Đầu tiên là công khai, sau đó được bảo vệ và sau đó là riêng tư.

3. Người xây dựng

4. Phương thức: Các phương thức này nên được nhóm theo chức năng thay vì theo phạm vi hoặc khả năng truy cập. Ví dụ, một phương thức lớp riêng có thể ở giữa hai phương thức cá thể công khai. Mục tiêu là để đọc và hiểu mã dễ dàng hơn.

Nguồn: http://www.oracle.com/technetwork/java/codeconventions-141855.html

Liên kết chính xác hơn với «Quy ước mã»: «Tuyên bố lớp và giao diện»

Không chắc chắn nếu có tiêu chuẩn được chấp nhận toàn cầu nhưng sở thích của riêng tôi là;

• nhà xây dựng đầu tiên
• Các phương thức tĩnh tiếp theo, nếu có một phương thức chính, luôn luôn trước các phương thức tĩnh khác
• phương thức không tĩnh tiếp theo, thường theo thứ tự tầm quan trọng của phương thức theo sau bởi bất kỳ phương thức nào mà nó gọi. Điều này có nghĩa là các phương thức công khai gọi các phương thức lớp khác xuất hiện ở phía trên và phương thức riêng gọi không có phương thức nào khác thường kết thúc ở phía dưới
• phương pháp tiêu chuẩn như toString, equalsvà hashcodetiếp theo
• getters và setters có một vị trí đặc biệt dành riêng ở cuối lớp

40 phương thức trong một lớp là hơi nhiều.

Sẽ có ý nghĩa khi chuyển một số chức năng sang các lớp khác - được đặt tên phù hợp -. Sau đó, nó là dễ dàng hơn nhiều để có ý nghĩa.

Khi bạn có ít hơn, việc liệt kê chúng theo thứ tự đọc tự nhiên sẽ dễ dàng hơn nhiều. Một mô hình thường xuyên là liệt kê những thứ trước hoặc sau khi bạn cần chúng, theo thứ tự bạn cần chúng.

Điều này thường có nghĩa là main()đi trên hoặc dưới cùng.

"Quy ước" của tôi: tĩnh trước cá thể, công khai trước riêng tư, hàm tạo trước các phương thức, nhưng phương thức chính ở dưới cùng (nếu có).

Ngoài ra, nhật thực cung cấp khả năng sắp xếp các thành viên lớp cho bạn, nếu bạn vì một lý do nào đó trộn lẫn chúng:

Mở tệp lớp của bạn, đi đến "Nguồn" trong menu chính và chọn "Sắp xếp thành viên".

lấy từ đây: Các phương thức sắp xếp trong Eclipse

Bạn đang sử dụng Eclipse? Nếu vậy tôi sẽ gắn bó với thứ tự sắp xếp thành viên mặc định, bởi vì điều đó có thể quen thuộc nhất với bất kỳ ai đọc mã của bạn (mặc dù đó không phải là thứ tự sắp xếp yêu thích của tôi.)