Bagaimana cara menandai bagian logis dari kode di komentar Java?

Kelas Java umumnya dibagi menjadi "blok" logis. Apakah ada konvensi untuk menandai bagian ini? Idealnya, ini akan didukung oleh IDE utama.

Saya pribadi menggunakan metode ini:

//// Section name here ////

Namun, beberapa editor sepertinya bermasalah dengan ini.

Sebagai contoh, dalam kode Objective-C Anda dapat menggunakan metode ini:

#pragma mark -
#pragma mark Section name here

Ini akan menghasilkan menu di Xcode yang terlihat seperti ini:

Saya pribadi menggunakan pemisah baris 80 karakter, seperti ini:

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;
    }

}

Tentu saja, ini mungkin tampak berlebihan untuk POJO sekecil itu, tetapi percayalah, ini terbukti sangat berguna dalam beberapa proyek besar di mana saya harus menelusuri file sumber besar dan dengan cepat menemukan metode yang saya minati. Ini juga membantu memahami struktur kode sumber.

Di Eclipse, saya telah membuat satu set template kustom (Java -> Editor -> Template di dialog Preferensi Eclipse) yang menghasilkan bar tersebut, misalnya. - sepa (SEParator untuk Accessors) - sepp (SEParator untuk Properties) - sepc (SEParator for Constructors) - dll.

Saya juga memodifikasi template standar "kelas baru" (Java -> Gaya Kode -> Template Kode di layar Preferensi Eclipse)

Juga, ada plugin Eclipse lama yang disebut Coffee-bytes , yang meningkatkan cara Eclipse melipat bagian kode. Saya tidak tahu apakah itu masih berfungsi, tapi saya ingat seseorang dapat mendefinisikan zona lipat yang dapat dilipat dengan menambahkan komentar khusus, seperti // [SECTION] atau semacamnya. Mungkin masih berfungsi dalam revisi Eclipse baru-baru ini, jadi lihatlah.

Untuk intellij / android studio ada solusi yang luar biasa.
Mulailah dengan:
//region Description
dan akhiri dengan:
//endregion

Pintasan untuk itu ada di menu yang dapat Anda buka dengan Command+ Alt+ T(Mac) atau Ctrl+ Alt+ T(Windows)

Anda juga dapat menambahkan garis Anda sendiri untuk pemisahan visual tambahan jika Anda membutuhkannya. Wilayah dapat dikontrak dan diperluas sesuka hati dengan tombol +/- seperti fungsi lainnya. Anda juga dapat menavigasi antar wilayah dengan Command+ Alt+ Period( Ctrl+ Alt+ Period)

Sumber .

Contoh:

//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 mendefinisikan anotasi javadoc @category (gulir ke bagian bertanda "Dukungan kategori") yang memungkinkan pemfilteran menurut kategori dalam tampilan garis besar. Tidak persis seperti yang Anda inginkan. Saya terkejut tidak ada yang menulis plugin Eclipse yang menawarkan tampilan seperti tangkapan layar Anda.

Saya juga suka itu ketika saya menggunakan xcode. Untuk gerhana saya menggunakan ctrl + o (garis besar cepat) untuk menavigasi melalui kelas Java.

Menggunakan komentar / penanda yang tidak perlu dalam kode untuk membantu pekerjaan mungkin bukan praktik yang baik. Saya memiliki sedikit ide tentang xcode dan pengembangan java tetapi semua dukungan IDE utama menemukan anggota tanpa penanda khusus seperti gerhana menunjukkan metode dan anggota menggunakan tampilan garis besar yang dapat dipicu menggunakan ctrl+O, Intellij (yang saya lebih suka menggunakan lebih banyak di mac dan memiliki edisi komunitas juga) memiliki konsep garis besar yang sama dan dapat diakses dengan cepat menggunakan (ctrl + f12). Jadi maksud saya di sini adalah jangan menggunakan markup yang tidak perlu dalam kode karena semua IDE (atau setidaknya yang baik / waras) dapat melakukannya secara otomatis.

Sejauh yang saya tahu tidak ada spesifikasi yang didukung untuk mengelompokkan anggota kelas bersama. Anda dapat menggunakan konvensi komentar apa pun yang Anda suka, tetapi kemungkinan besar itu tidak akan didukung oleh alat apa pun.

Lebih baik mengelompokkan anggota terkait ke dalam kelas terpisah melalui warisan atau agregasi. Ini dianggap sebagai gaya OOP yang bagus

Selain jawaban Andrey yang diberikan, untuk menggunakan // region // endregion, kami memasukkan [huruf BigAscii] [1] di bagian kode utama. Saat menggulir dengan cepat, itu sangat menonjol. Satu kelemahan dari pendekatan ini adalah saya tidak dapat mencarinya jadi Anda perlu menambahkan istilah pencarian tepat di bawah "spanduk" seperti yang saya lakukan di bawah ini.

Blockquote

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

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

Saya akan menggunakan javadoc ; atau gunakan berikut ini sebagai "pemisah" sederhana (satu atau 3 baris):

/** RecyclerOnItemClickListener */

/** 
 * RecyclerOnItemClickListener
 */

Sehingga di IDE muncul dalam warna yang berbeda selain abu-abu yang tidak mencolok dikomentari.

IDE modern memungkinkan Anda untuk melihat kode Anda dengan berbagai cara, dan bahkan mengaturnya kembali. Eclipse bahkan memungkinkan Anda untuk melihat definisi kode tempat Anda memiliki kursor di panel lain.

Setiap pengaturan ulang otomatis kode Anda, akan menyebabkan markup tersebut rusak.

Jika Anda ingin mengelompokkan, pertimbangkan untuk menggabungkan barang-barang di kelas yang sama, dan barang-barang yang tidak dimiliki bersama di kelas yang berbeda.

Jika Anda bisa mengelompokkan metode Anda, lakukan kelas lain secara khusus untuk konsep yang ingin Anda tangkap di bagian. Silakan, membuat file gratis.

Untuk IntelliJ saya suka:

        public void ________________INIT__________________() {};

terlihat cantik dalam struktur file!