Java kodunun belirli bölümleri için Eclipse kod biçimlendiricisini nasıl kapatabilirim?

Java dizeleri olarak yazılmış SQL deyimleri ile bazı Java kodu var (lütfen hiçbir OR / M flamewars, gömülü SQL ne olduğunu - benim kararım değil).

Ben bakım kolaylığı için kod birkaç satır üzerinden birkaç bitmiş dizeleri içine semantik SQL ifadeleri kırık ettik. Yani şöyle bir şey yerine:

String query = "SELECT FOO, BAR, BAZ FROM ABC WHERE BAR > 4";

Benim gibi bir şey var:

String query =
    "SELECT FOO, BAR, BAZ" +
    "  FROM ABC          " +
    " WHERE BAR > 4      ";

Bu stil, özellikle büyük sorgular için SQL'in okunmasını ve bakımını (IMHO) kolaylaştırır. Örneğin, düzenleyicimi "üzerine yazma" moduna geçirebilir ve metni yerinde kolayca değiştirebilirim.

Bu sorunun belirli bir SQL örneğinin ötesinde genelleştirildiğini unutmayın. Herhangi bir dikey biçimlendirmeyle yazılmış kodlar, özellikle tablo yapıları, güzel bir yazıcı tarafından imha edilebilir.

Şimdi, bazı proje üyeleri Eclipse düzenleyicisini kullanıyor ve anlamsal biçimlendirme genellikle tüm kaynak dosyayı biçimlendirdiklerinde yok ediliyor.

Eclipse'e biçimlendirme ile ilgili belirli kaynak satırlarını yoksayması talimatı vermenin bir yolu var mı?

Eclipse biçimlendiricisini değiştiren özel bir yorum gibi bir şey arıyorum. İdeal olarak, böyle bir yorum seçtiğimiz şekilde yapılandırılabilir ve diğer formatlayıcılar da ona saygı gösterecek şekilde programlanabilir:

// STOP-ECLIPSE-FORMATTING
String query =
    "SELECT FOO, BAR, BAZ" +
    "  FROM ABC          " +
    " WHERE BAR > 4      ";
// START-ECLIPSE-FORMATTING

Açıkçası, bir "çözüm", ekip üyelerimizin Jalopy veya JIndent gibi bazı dış biçimlendiricilerde standart hale getirmelerini sağlamaktır , ancak bu sorunun konusu bu değildir (ayrıca, bu projedeki kararım değil): Özellikle Eclipse formatlayıcıdan geçici olarak kaçının.

İdeal olarak, bir çözüm Eclipse kullanan ekip üyelerinin herhangi bir IDE yeniden yapılandırması yapmasını gerektirmeden Eclipse formatlayıcı için talimatlar eklememe izin verecektir (muhtemelen bir formatter agnostik komut yorumu seçmekten başka: STOP-ECLIPSE-FORMATTING→ STOP-FORMATTING).

Eclipse 3.6, özel bir yorum ekleyerek biçimlendirmeyi kapatmanıza olanak tanır.

// @formatter:off
...
// @formatter:on

Açma / kapama özellikleri Eclipse tercihlerinde "açık" açık olması gerekiyor: Java > Code Style > Formatter. Tıklayın Edit, Off/On Tagsetkinleştirmek Enable Off/On tags.

Tercihlerdeki sihirli dizeleri değiştirmek de mümkündür - Eclipse 3.6 belgelerine buradan göz atın .

Daha fazla bilgi

Java > Code Style > Formatter > Edit > Off/On Tags

Bu tercih, devre dışı bırakılacak bir etiketi ve biçimlendiriciyi etkinleştirmek için bir etiket tanımlamanızı sağlar (biçimlendirici profilinizdeki Kapalı / Açık Etiketler sekmesine bakın):

Ayrıca, Java Formatting

Biçimlendiricideki Eclipse 3.5 M4'ten gelen AFAIK'te, kullanıcı satır sonlarını koruyan "Asla Hatlara Katılma" seçeneği vardır. Belki de istediğini yapar.

Yoksa bu çirkin kesmek var

String query = //
    "SELECT FOO, BAR, BAZ" + //
    "  FROM ABC"           + //
    " WHERE BAR > 4";

SO ile ilgili bu cevaba bakınız .

Belirli blok yorumlarının biçimlendirmesini bastırmak için kullanabileceğiniz başka bir çözüm daha vardır. /*-Blok yorumun başlangıcında (tire işaretini kullanın) kullanın ; dosyanın geri kalanını biçimlendirirseniz biçimlendirme etkilenmez.

/*-
 * Here is a block comment with some very special
 * formatting that I want indent(1) to ignore.
 *
 *    one
 *        two
 *            three
 */

Kaynak: Oracle'daki belgeler .

Biçimlendirmeyi kapatmak yerine, önceden sarılmış satırlara katılmayacak şekilde yapılandırabilirsiniz. Jitter cevabına benzer şekilde, Eclipse STS için de burada:

Özellikler → Java Kod Stili → Biçimlendirici → Projeye özgü ayarları etkinleştir VEYA Çalışma Alanı Ayarlarını Yapılandır → Düzenle → Satır Sarma (sekme) → "Asla sarılmış satırlara asla katılma" seçeneğini işaretleyin

Kaydet, uygula.

Formatlayıcı etiketlerini ekleme yeteneğini açmanız gerekir. Menubarda şu adrese gidin:

Windows → Preferences Java → Code Style → Formatter

Düğmesine basın Edit. Son sekmeyi seçin. Açık / Kapalı kutusuna dikkat edin ve bir onay kutusuyla etkinleştirin.

Artı işaretini satırın başına koyarsanız, farklı biçimlendirir:

String query = 
    "SELECT FOO, BAR, BAZ" 
    +    "  FROM ABC"           
    +    " WHERE BAR > 4";

Ben biçimlendirici benim SQL dize girintisi kadar karışıklık önlemek için sabit genişlik dize parçaları (boşluk ile yastıklı) kullanıyorum. Bu size karışık sonuçlar verir ve boşlukların SQL'de olduğu gibi göz ardı edilmediği, ancak yardımcı olabileceği yerlerde çalışmaz.

    final String sql = "SELECT v.value FROM properties p               "
            + "JOIN property_values v ON p.property_id = v.property_id "
            + "WHERE p.product_id = ?                                  "
            + "AND v.value        IS NOT NULL                          ";

Satırların her birini çift eğik çizgi "//" ile bitirin. Bu, tutulmanın hepsini aynı hatta taşımasını engelleyecektir.

Alternatif yöntem: Eclipse 3.6'da, "Satır Sarma" ve ardından "Genel Ayarlar" altında "Asla sarılmış satırlara asla katılma" seçeneği vardır. Bu, biçimlendiricinin uzun satırları saracağı, ancak zaten sahip olduğunuz herhangi bir sargıyı geri almayacağı anlamına gelir.

@xpmatteo, kod bölümlerini devre dışı bırakma cevabına sahiptir, ancak buna ek olarak, varsayılan tutulma ayarları tüm dosya yerine yalnızca düzenlenmiş kod satırlarını biçimlendirecek şekilde ayarlanmalıdır.

Preferences->Java->Editor->Save Actions->Format Source Code->Format Edited Lines

Bu, iş arkadaşlarınızın aslında değiştirmedikleri kodu yeniden biçimlendirdikleri için ilk etapta olmasını engellerdi. Bu, kaynak kontrolünüzde fark yaratmayan aksaklıkları önlemek için iyi bir uygulamadır (küçük format ayarı farklılıkları nedeniyle tüm dosya yeniden biçimlendirildiğinde).

Ayrıca, açma / kapama etiketleri seçeneği kapatılırsa yeniden biçimlendirmeyi de önler.

//Yeni çizgiler istediğiniz yere ekleyerek hayali yorumlar harika!

1. @Formatter: off, koddan düzenleyiciye bir başvuru ekler. Kod, bence, böyle referanslara sahip olmamalıdır.

2. Hayali yorumlar (//) kullanılan biçimlendirme aracından bağımsız olarak çalışır. Eclipse, InteliJ veya kullandığınız herhangi bir düzenleyiciden bağımsız olarak. Bu, çok güzel Google Java Biçimi ile bile çalışır

3. Hayali yorumlar (//) uygulamanızın her yerinde çalışır. Ayrıca Javascript'iniz varsa ve JSBeautifier gibi bir şey kullanabilirsiniz . Javascript'te de benzer kod stiline sahip olabilirsiniz.

4. Aslında, büyük olasılıkla biçimlendirme istiyor musunuz? Karışık sekmeyi / boşluğu ve sondaki boşlukları kaldırmak istiyorsunuz. Satırları kod standardına göre girinti yapmak istiyorsunuz. DONT istediğin uzun bir çizgi. Bu ve sadece bu, hayalet yorumunun size verdiği şeydir!

Bu kesmek işe yarıyor:

String x = "s" + //Formatter Hack
    "a" + //
    "c" + //
    "d";

Formatlayıcıyı kullanmamanızı öneririm. Kötü kod yapay olarak iyi değil kötü görünmelidir. İyi kod zaman alır. Kaliteyi aldatamazsınız. Biçimlendirme, kaynak kodu kalitesinin bir parçasıdır.