Làm cách nào để đánh dấu các đoạn mã hợp lý trong các bình luận Java?

Các lớp Java thường được chia thành các "khối" logic. Có một quy ước để đánh dấu các phần này? Lý tưởng nhất là nó sẽ được hỗ trợ bởi các IDE chính.

Cá nhân tôi sử dụng phương pháp này:

//// Section name here ////

Tuy nhiên, một số biên tập viên dường như gặp vấn đề với điều này.

Ví dụ, trong mã Objective-C, bạn có thể sử dụng phương pháp này:

#pragma mark -
#pragma mark Section name here

Điều này sẽ dẫn đến một menu trong XCode trông giống như sau:

Cá nhân tôi sử dụng dấu phân cách dòng 80 ký tự, như sau:

public class Client {

    //================================================================================
    // Properties
    //================================================================================

    private String name;
    private boolean checked;

    //================================================================================
    // Constructors
    //================================================================================

    public Client() {
    }

    public Client(String name, boolean checked) {
        this.name = name;
        this.checked = checked;
    }

    //================================================================================
    // Accessors
    //================================================================================

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public boolean isChecked() {
        return checked;
    }

    public void setChecked(boolean checked) {
        this.checked = checked;
    }

}

Tất nhiên, điều này có vẻ hơi quá mức cần thiết đối với một POJO nhỏ như vậy, nhưng tin tôi đi, nó tỏ ra rất hữu ích trong một số dự án lớn nơi tôi phải duyệt qua các tệp nguồn lớn và nhanh chóng tìm thấy các phương pháp tôi quan tâm. Nó cũng giúp hiểu cấu trúc mã nguồn.

Trong Eclipse, tôi đã tạo một tập hợp các mẫu tùy chỉnh (Java -> Trình chỉnh sửa -> Mẫu trong hộp thoại Tùy chọn của Eclipse) để tạo các thanh đó, ví dụ: - sepa (SEParator cho Accessors) - sepp (SEParator cho Properties) - sepc (SEParator cho Constructors) - v.v.

Tôi cũng đã sửa đổi mẫu "lớp mới" tiêu chuẩn (Java -> Kiểu mã -> Mẫu mã trong màn hình Tùy chọn Eclipse)

Ngoài ra, có một plugin Eclipse cũ được gọi là Coffee-bytes , giúp nâng cao cách Eclipse gấp các phần mã. Tôi không biết liệu nó có còn hoạt động hay không, nhưng tôi nhớ rằng người ta có thể xác định các vùng có thể gập lại tùy ý bằng cách thêm các nhận xét đặc biệt, như // [SECTION] hoặc một cái gì đó. Nó có thể vẫn hoạt động trong các bản sửa đổi Eclipse gần đây, vì vậy hãy xem.

Đối với studio intellij / android có một giải pháp tuyệt vời.
Bắt đầu bằng:
//region Description
và kết thúc bằng:
//endregion

Phím tắt cho điều đó nằm trong menu bạn có thể mở bằng Command+ Alt+ T(Mac) hoặc Ctrl+ Alt+ T(Windows)

Bạn cũng có thể thêm dòng của riêng mình để phân tách trực quan bổ sung nếu bạn cần. Vùng có thể được thu nhỏ và mở rộng theo ý muốn bằng các nút +/- giống như bất kỳ chức năng nào. Bạn cũng có thể điều hướng giữa các vùng bằng Command+ Alt+ Period( Ctrl+ Alt+ Period)

Nguồn .

Thí dụ:

//region Parceler Implementation
//---------------------------------------------------------------------------------------
@Override
public int describeContents() {
    return 0;
}

@Override
public void writeToParcel(Parcel dest, int flags) {
    dest.writeParcelable(this.die, 0);
    dest.writeParcelable(this.dieSprite, 0);
}

private DieVm(Parcel in) {
    this.die = in.readParcelable(Die.class.getClassLoader());
    this.dieSprite = in.readParcelable(Sprite.class.getClassLoader());
}

public static final Parcelable.Creator<DieVm> CREATOR = new Parcelable.Creator<DieVm>() {
    public DieVm createFromParcel(Parcel source) {
        return new DieVm(source);
    }

    public DieVm[] newArray(int size) {
        return new DieVm[size];
    }
};
//---------------------------------------------------------------------------------------
//endregion

Eclipse xác định chú thích @category javadoc (cuộn đến phần được đánh dấu "Hỗ trợ danh mục") cho phép lọc theo danh mục trong dạng xem phác thảo. Không chính xác như những gì bạn muốn sao. Tôi ngạc nhiên là không ai viết plugin Eclipse cung cấp chế độ xem như ảnh chụp màn hình của bạn.

Tôi cũng thích điều đó khi tôi đang sử dụng xcode. Đối với nhật thực, tôi sử dụng ctrl + o (phác thảo nhanh) để điều hướng qua một lớp Java.

Sử dụng các nhận xét / điểm đánh dấu không cần thiết trong mã để giúp hoạt động có thể không phải là một thực tiễn tốt. Tôi có chút ý tưởng về việc phát triển xcode và java nhưng tất cả sự hỗ trợ của IDE chính trong việc tìm kiếm các thành viên không có bất kỳ điểm đánh dấu đặc biệt nào như eclipse cho thấy các phương pháp và thành viên sử dụng chế độ xem phác thảo có thể được kích hoạt bằng ctrl+OIntellij (mà tôi thích sử dụng hơn trên mac và có phiên bản cộng đồng cũng vậy) có cùng khái niệm phác thảo và có thể nhanh chóng truy cập bằng cách sử dụng (ctrl + f12). Vì vậy, quan điểm của tôi ở đây là không sử dụng bất kỳ đánh dấu không cần thiết nào trong mã vì tất cả (hoặc ít nhất là tốt / lành mạnh) IDE có thể tự động làm điều đó.

Theo như tôi biết thì không có cái gọi là đặc điểm kỹ thuật được hỗ trợ để nhóm các thành viên trong lớp lại với nhau. Bạn có thể sử dụng quy ước bình luận từng có mà bạn thích, nhưng rất có thể nó sẽ không được bất kỳ công cụ nào hỗ trợ.

Tốt hơn là nhóm các thành viên có liên quan thành lớp riêng biệt thông qua kế thừa hoặc tổng hợp. Đây được coi là một phong cách OOP tốt

Ngoài câu trả lời của Andrey đã cung cấp, để sử dụng // khu vực // endregion, chúng tôi chèn [các chữ cái BigAscii] [1] vào các phần mã chính. Khi cuộn nhanh, nó thực sự nổi bật. Một nhược điểm của phương pháp này là tôi không thể tìm kiếm nó, vì vậy bạn cần thêm một cụm từ tìm kiếm ngay bên dưới "biểu ngữ" như tôi làm dưới đây.

Blockquote

//    _      _____          _____                  _   _
//   | |    |  __ \   /\   |  __ \      /\        | | | |
//   | |    | |  | | /  \  | |__) |    /  \  _   _| |_| |__
//   | |    | |  | |/ /\ \ |  ___/    / /\ \| | | | __| '_ \
//   | |____| |__| / ____ \| |       / ____ \ |_| | |_| | | |
//   |______|_____/_/    \_\_|      /_/    \_\__,_|\__|_| |_|
//
//   Search here with: LDAP Auth

[1]: http://patorjk.com/software/taag/#p=display&c=c%2B%2B&f=Big&t=LDAP Auth

Tôi sẽ sử dụng javadoc ; hoặc sử dụng phần sau làm "dấu phân cách" đơn giản (một hoặc 3 dòng):

/** RecyclerOnItemClickListener */

/** 
 * RecyclerOnItemClickListener
 */

Vì vậy, trong IDE, nó xuất hiện với một màu khác với màu xám được nhận xét không phô trương.

Một IDE hiện đại cho phép bạn xem mã của mình theo nhiều cách khác nhau và thậm chí tổ chức lại nó. Eclipse thậm chí còn cho phép bạn xem định nghĩa của mã mà bạn có con trỏ trên bảng điều khiển khác.

Bất kỳ sự sắp xếp lại mã tự động nào của bạn, sẽ khiến đánh dấu đó bị phá vỡ.

Nếu bạn muốn nhóm lại thì hãy cân nhắc đặt những thứ thuộc cùng một lớp và những thứ không thuộc cùng nhau vào các lớp khác nhau.

Nếu bạn có thể phân cụm các phương thức của mình, hãy tạo một lớp khác cụ thể cho khái niệm mà bạn muốn nắm bắt trong một phần. Hãy tiếp tục, tạo tệp là miễn phí.

Đối với IntelliJ, tôi thích:

        public void ________________INIT__________________() {};

trông khá đẹp trong cấu trúc tệp!