จะปิดฟอร์แมตโค้ด Eclipse สำหรับบางส่วนของโค้ด Java ได้อย่างไร

ฉันมีโค้ด Java บางตัวที่มีคำสั่ง SQL เขียนเป็นสตริง Java (โปรดอย่า flamewars OR / M, SQL ฝังตัวคืออะไร - ไม่ใช่การตัดสินใจของฉัน)

ฉันใช้คำสั่ง SQL แบบ semantically เป็นสตริงที่ต่อกันหลายบรรทัดเพื่อให้ง่ายต่อการบำรุงรักษา ดังนั้นแทนที่จะชอบ:

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

ฉันมีสิ่งที่ชอบ:

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

สไตล์นี้ทำให้ SQL อ่านและดูแลรักษาง่ายขึ้น (IMHO) โดยเฉพาะอย่างยิ่งสำหรับข้อความค้นหาที่มีขนาดใหญ่ขึ้น ตัวอย่างเช่นฉันสามารถใส่เครื่องมือแก้ไขของฉันในโหมด "เขียนทับ" และแก้ไขข้อความในสถานที่ได้อย่างง่ายดาย

โปรดทราบว่าปัญหานี้เป็นการสรุปที่เกินกว่าตัวอย่างเฉพาะของ SQL โค้ดใด ๆ ที่ถูกเขียนด้วยการจัดรูปแบบแนวตั้งโดยเฉพาะโครงสร้างแบบตารางจะไวต่อการถูกทำลายโดยเครื่องพิมพ์สวย ๆ

ตอนนี้สมาชิกโปรเจ็กต์บางคนใช้ตัวแก้ไข Eclipse และการจัดรูปแบบความหมายมักจะถูกทำลายเมื่อพวกเขาจัดรูปแบบไฟล์ต้นฉบับทั้งหมด

มีวิธีในการสั่งให้ Eclipse ละเว้นบรรทัดของแหล่งที่มาบางอย่างเกี่ยวกับการจัดรูปแบบหรือไม่?

ฉันกำลังมองหาบางอย่างเช่นความคิดเห็นพิเศษที่สลับรูปแบบ Eclipse เป็นการดีที่ความคิดเห็นดังกล่าวสามารถกำหนดค่าให้เป็นสิ่งที่เราเลือกและจัดรูปแบบอื่น ๆ สามารถตั้งโปรแกรมให้เคารพมันเช่นกัน:

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

เห็นได้ชัดว่าเป็นหนึ่งใน "การแก้ปัญหา" คือการมีสมาชิกในทีมของเราเป็นมาตรฐานในบางตัวจัดรูปแบบภายนอกเช่นJalopyหรือJIndentแต่นั่นไม่ใช่สิ่งที่คำถามนี้เป็นเรื่องเกี่ยวกับ (ยังไม่ได้ตัดสินใจของฉันในโครงการนี้): ฉันกำลังมองหาเฉพาะวิธีการ หลีกเลี่ยงการจัดรูปแบบ Eclipse บนพื้นฐานแบบเฉพาะกิจ

ตามหลักการแล้วโซลูชันจะอนุญาตให้ฉันแทรกคำแนะนำสำหรับการจัดรูปแบบ Eclipse โดยไม่ต้องการสมาชิกในทีมที่ใช้ Eclipse เพื่อทำการตั้งค่า IDE ใหม่ (นอกเหนือจากการเลือกคำสั่ง formatter agnostic comment: STOP-ECLIPSE-FORMATTING→ STOP-FORMATTING)

Eclipse 3.6 ช่วยให้คุณสามารถปิดการจัดรูปแบบโดยการแสดงความคิดเห็นพิเศษเช่น

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

เปิด / ปิดคุณสมบัติจะต้องมีการเปิด "กับ" ในการตั้งค่า Java > Code Style > FormatterEclipse: คลิกที่Edit, เปิดใช้งานOff/On TagsEnable Off/On tags

นอกจากนี้ยังเป็นไปได้ที่จะเปลี่ยนสายเวทมนตร์ในการตั้งค่า - ตรวจสอบ Eclipse 3.6 เอกสารที่นี่

ข้อมูลมากกว่านี้

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

การตั้งค่านี้ช่วยให้คุณสามารถกำหนดหนึ่งแท็กเพื่อปิดการใช้งานและอีกหนึ่งแท็กเพื่อเปิดใช้งานตัวจัดรูปแบบ (ดูที่แท็บปิด / เปิดแท็กในโปรไฟล์ตัวจัดรูปแบบของคุณ):

คุณต้องเปิดใช้งานแฟล็กจาก Java Formatting

AFAIK จาก Eclipse 3.5 M4 บนตัวจัดรูปแบบมีตัวเลือก "ไม่เข้าร่วมสาย" ซึ่งจะรักษาเส้นแบ่งผู้ใช้ บางทีนั่นอาจเป็นสิ่งที่คุณต้องการ

มีแฮ็คที่น่าเกลียดนี้หรือไม่

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

ดูคำตอบเกี่ยวกับเรื่องนี้ดังนั้น

มีวิธีแก้ไขปัญหาอื่นที่คุณสามารถใช้เพื่อระงับการจัดรูปแบบของข้อคิดเห็นบล็อกเฉพาะ ใช้/*-(หมายเหตุยัติภังค์) ที่จุดเริ่มต้นของความคิดเห็นบล็อกและการจัดรูปแบบจะไม่ได้รับผลกระทบหากคุณจัดรูปแบบส่วนที่เหลือของไฟล์

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

ที่มา: เอกสารที่ Oracle

แทนที่จะปิดการจัดรูปแบบคุณสามารถกำหนดค่าให้ไม่เข้าร่วมบรรทัดที่ล้อมรอบแล้ว คล้ายกับการตอบสนองของ Jitter ต่อไปนี้เป็น Eclipse STS:

คุณสมบัติ→สไตล์รหัส Java →ฟอร์แมตเตอร์→เปิดใช้งานการตั้งค่าเฉพาะโครงการหรือกำหนดค่าการตั้งค่าพื้นที่ทำงาน→แก้ไข→การตัดบรรทัด (แท็บ) →ตรวจสอบ "ไม่เคยเข้าร่วมบรรทัดที่ถูกห่อแล้ว"

บันทึกใช้

คุณต้องเปิดความสามารถในการเพิ่มแท็กตัวจัดรูปแบบ ในแถบเมนูไปที่:

Windows → Preferences Java → Code Style → Formatter

กดEditปุ่ม เลือกแท็บสุดท้าย สังเกตเห็นกล่องเปิด / ปิดและเปิดใช้งานด้วยช่องทำเครื่องหมาย

หากคุณใส่เครื่องหมายบวกที่จุดเริ่มต้นของบรรทัดรูปแบบจะแตกต่างกัน:

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

ฉันใช้ส่วนสตริงความกว้างคงที่ (เบาะด้วยช่องว่าง) เพื่อหลีกเลี่ยงการจัดรูปแบบเลอะการเยื้องสตริง SQL ของฉัน สิ่งนี้จะให้ผลลัพธ์ที่หลากหลายแก่คุณและจะไม่ทำงานในกรณีที่ช่องว่างไม่ได้ถูกละเว้นเหมือนใน SQL แต่มีประโยชน์

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

จบแต่ละบรรทัดด้วยเครื่องหมายสแลชคู่ "//" ที่จะป้องกันคราสจากการเคลื่อนย้ายพวกมันทั้งหมดไปยังบรรทัดเดียวกัน

วิธีอื่น: ใน Eclipse 3.6 ภายใต้ "การตัดบรรทัด" จากนั้น "ตั้งค่าทั่วไป" มีตัวเลือกที่จะ "ไม่เข้าร่วมบรรทัดที่พันแล้ว" ซึ่งหมายความว่าตัวจัดรูปแบบจะตัดบรรทัดที่ยาว แต่ไม่เลิกทำการตัดคำที่คุณมี

@xpmatteo มีคำตอบสำหรับการปิดการใช้งานบางส่วนของรหัส แต่นอกเหนือจากนี้การตั้งค่าเริ่มต้นของ eclipse ควรถูกตั้งค่าเป็นฟอร์แมตบรรทัดของโค้ดที่แก้ไขเท่านั้นแทนที่จะเป็นไฟล์ทั้งหมด

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

สิ่งนี้จะป้องกันไม่ให้เกิดขึ้นตั้งแต่แรกเพราะเพื่อนร่วมงานของคุณกำลังฟอร์แมตโค้ดใหม่ซึ่งพวกเขาไม่ได้เปลี่ยนจริง นี่เป็นวิธีปฏิบัติที่ดีในการป้องกันไม่ให้เกิดอุบัติเหตุที่ทำให้การควบคุมแหล่งข้อมูลของคุณไร้ประโยชน์ (เมื่อไฟล์ทั้งหมดถูกฟอร์แมตใหม่เนื่องจากความแตกต่างของการตั้งค่ารูปแบบเล็กน้อย)

มันจะป้องกันการจัดรูปแบบถ้าตัวเลือกเปิด / ปิดแท็กถูกปิด

ความคิดเห็นแฟนทอมเพิ่ม//ที่คุณต้องการบรรทัดใหม่ที่ดี!

1. กระบวนการ @formatter: off เพิ่มการอ้างอิงจากรหัสไปยังตัวแก้ไข ในความคิดของฉันรหัสควรไม่เคยมีการอ้างอิงดังกล่าว

2. ความคิดเห็นแฝง (//) จะทำงานโดยไม่คำนึงถึงเครื่องมือการจัดรูปแบบที่ใช้ โดยไม่คำนึงถึง Eclipse หรือ InteliJ หรือโปรแกรมแก้ไขใด ๆ ที่คุณใช้ สิ่งนี้สามารถใช้งานได้กับรูปแบบ Google Java ที่ดีมาก

3. ความเห็นแฝง (//) จะใช้ได้กับแอปพลิเคชันของคุณทั้งหมด หากคุณยังมี Javascript และบางทีอาจจะใช้สิ่งที่ต้องการJSBeautifier คุณสามารถมีสไตล์ของรหัสที่คล้ายกันได้ใน Javascript

4. ที่จริงแล้วคุณอาจต้องการฟอร์แมตใช่ไหม คุณต้องการลบแท็บ / พื้นที่และช่องว่างต่อท้ายแบบผสม คุณต้องการเยื้องบรรทัดตามมาตรฐานรหัส สิ่งที่คุณไม่ต้องการคือเส้นยาว และนั่นก็คือสิ่งที่ความคิดเห็นแฝงให้คุณ!

แฮ็คนี้ใช้งานได้:

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

ฉันอยากจะแนะนำไม่ให้ใช้ตัวจัดรูปแบบ รหัสที่ไม่ดีควรดูไม่ดีไม่ดีเกินจริง รหัสที่ดีต้องใช้เวลา คุณไม่สามารถโกงคุณภาพ การจัดรูปแบบเป็นส่วนหนึ่งของคุณภาพซอร์สโค้ด