Java yorumlarında mantıksal kod bölümleri nasıl işaretlenir?

Java sınıfları genellikle mantıksal "bloklara" ayrılır. Bu bölümleri işaretlemek için bir kongre var mı? İdeal olarak, büyük IDE'ler tarafından desteklenecektir.

Ben şahsen bu yöntemi kullanıyorum:

//// Section name here ////

Ancak bazı editörlerin bununla ilgili sorunları var gibi görünüyor.

Örnek olarak, Objective-C kodunda şu yöntemi kullanabilirsiniz:

#pragma mark -
#pragma mark Section name here

Bu, XCode'da şuna benzer bir menü ile sonuçlanacaktır:

Şahsen 80 karakterlik satır ayırıcıları kullanıyorum, şöyle:

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

}

Elbette, bu kadar küçük bir POJO için bu biraz abartılı görünebilir, ancak inanın bana, büyük kaynak dosyalara göz atmam ve ilgilendiğim yöntemleri hızlıca bulmam gereken bazı büyük projelerde çok faydalı olduğunu kanıtladı. kaynak kod yapısı.

Eclipse'de, bu çubukları oluşturan bir dizi özel şablon (Java -> Editör -> Eclipse'nin Tercihler iletişim kutusundaki Şablonlar) oluşturdum, örn. - sepa (Erişimciler için SEParator) - sepp (Özellikler için SEParator) - sepc (Yapıcılar için SEParator) - vb.

Standart "yeni sınıf" şablonunu da değiştirdim (Eclipse Tercihleri ​​ekranında Java -> Kod Stili -> Kod Şablonları)

Ayrıca, Eclipse'in kod bölümlerini katlama şeklini geliştiren Coffee-bytes adlı eski bir Eclipse eklentisi var . Hala çalışıp çalışmadığını bilmiyorum, ancak birinin // [SECTION] veya başka bir şey gibi özel yorumlar ekleyerek keyfi katlanabilir bölgeler tanımlayabileceğini hatırladım. Hala son Eclipse revizyonlarında çalışabilir, bu yüzden bir göz atın.

İntellij / android stüdyosu için harika bir çözüm var.
Şununla başlayın:
//region Description
ve şununla bitirin:
//endregion

Bunun kısayolu, Command+ Alt+ T(Mac) veya Ctrl+ Alt+ T(Windows) ile açabileceğiniz menüdedir.

İhtiyaç duyduğunuzda ek görsel ayrım için kendi çizginizi de ekleyebilirsiniz. Bölge, herhangi bir işlevde olduğu gibi +/- düğmeleriyle daraltılabilir ve genişletilebilir. Command+ Alt+ Period( Ctrl+ Alt+ Period) İle bölgeler arasında da gezinebilirsiniz.

Kaynak .

Misal:

//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 , anahat görünümünde kategoriye göre filtrelemeyi etkinleştiren bir @category javadoc ek açıklamasını ("Kategori desteği" olarak işaretlenmiş bölüme kaydırın) tanımlar . Tam olarak istediğin şey değil mi. Hiç kimsenin ekran görüntünüz gibi bir görünüm sunan bir Eclipse eklentisi yazmamış olmasına şaşırdım.

Bunu xcode kullanırken de beğendim. Tutulma için bir Java sınıfında gezinmek için ctrl + o (hızlı anahat) kullanıyorum.

Çalışmaya yardımcı olmak için kodda gereksiz yorumlar / işaretler kullanmak iyi bir uygulama olmayabilir. Xcode ve java geliştirme hakkında çok az fikrim var, ancak tüm büyük IDE'lerin, eclipse gibi herhangi bir özel işaret olmadan üyeleri bulma desteği ctrl+O, Intellij (Mac'te daha fazla kullanmayı tercih ettiğim ve bir topluluk sürümü de) aynı anahat konseptine sahiptir ve (ctrl + f12) kullanılarak hızlı bir şekilde erişilebilir. Yani buradaki amacım, tüm (veya en azından iyi / aklı başında) IDE'lerin otomatik olarak yapabileceği için, kodda gereksiz işaretleme kullanmayın.

Bildiğim kadarıyla, sınıf üyelerini bir arada gruplandırmak için desteklenen bir belirtim diye bir şey yok. İstediğiniz her türlü yorum kuralını kullanabilirsiniz, ancak muhtemelen herhangi bir araç tarafından desteklenmeyecektir.

İlgili üyeleri miras alma veya toplama yoluyla ayrı bir sınıfa gruplamak daha iyidir. Bu, iyi bir OOP stili olarak kabul edilir

Javadoc kullanırdım ; veya aşağıdakileri basit bir "ayırıcı" olarak kullanın (tek veya 3 satır):

/** RecyclerOnItemClickListener */

/** 
 * RecyclerOnItemClickListener
 */

Böylece IDE'de göze çarpmayan yorumlu griden farklı bir renkte görünür.

Andrei'nin verdiği cevaba ek olarak, bölge // uç bölgeyi kullanmak için //, ana kod bölümlerine [BigAscii harfleri] [1] ekliyoruz. Hızlı kaydırırken gerçekten göze çarpıyor. Bu yaklaşımın bir dezavantajı, onu arayamamam, bu nedenle aşağıda yaptığım gibi "banner" ın hemen altına bir arama terimi eklemeniz gerekmesidir.

Blok alıntı

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

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

Modern bir IDE, kodunuzu birçok farklı şekilde görüntülemenize ve hatta yeniden düzenlemenize olanak tanır. Eclipse, imlecin bulunduğu kodun tanımını başka bir panelde görüntülemenize bile izin verir.

Kodunuzun otomatik olarak yeniden düzenlenmesi, bu tür işaretlemenin bozulmasına neden olur.

Gruplama istiyorsanız, aynı sınıfa ait olan şeyleri bir araya getirmeyi ve farklı sınıflarda birbirine ait olmayan şeyleri düşünün.

Yöntemlerinizi kümelendirebilirseniz, bir bölümde yakalamak istediğiniz kavram için özel olarak başka bir sınıf yapın. Devam edin, dosya oluşturmak ücretsizdir.

IntelliJ için beğendim:

        public void ________________INIT__________________() {};

dosya yapısında güzel görünüyor!