คอฟฟี่เบรค #86 คำแนะนำที่ง่ายและรวดเร็วในการจัดรูปแบบโค้ดใหม่ใน IntelliJ IDEA

ที่มา: Lightrun ในฐานะนักพัฒนา คุณจะต้องทำการเปลี่ยนแปลงโค้ดเบส และหากฐานโค้ดไม่ได้รับการจัดรูปแบบอย่างชัดเจน การดีบักก็จะยากขึ้นสำหรับคุณมาก การเปลี่ยนแปลงเล็กๆ น้อยๆ เช่น การจัดรูปแบบใหม่และการเยื้องโค้ดอย่างเหมาะสมมักถูกมองข้ามไป แต่เห็นได้ชัดว่าการเปลี่ยนแปลงเหล่านี้ช่วยแยกความแตกต่างของ codebase ของนักพัฒนามืออาชีพจาก codebase ของผู้เริ่มต้น การรักษาการจัดรูปแบบโค้ดและการเยื้องโค้ดให้เหมาะสมจะช่วยให้คุณเขียนโค้ดที่อ่านง่ายขึ้น สิ่งนี้ช่วยลดความยุ่งยากในการทำงานร่วมกันในโครงการ เพิ่มความเร็วในการแก้ไขจุดบกพร่อง และการรักษาฐานโค้ด โค้ดสามารถอ่านได้และมีโครงสร้างมากขึ้น เป็นไปได้หรือไม่ที่จะเร่งกระบวนการฟอร์แมตโค้ดใหม่? บทความนี้จะแนะนำวิธีการง่ายๆ ในการจัดรูปแบบโค้ดใหม่โดยอัตโนมัติโดยใช้ IntelliJ IDEA คุณจะได้เรียนรู้วิธีลดเวลาที่ต้องใช้สำหรับขั้นตอนนี้ และคุณจะได้เรียนรู้วิธีแยกส่วนของโค้ดเบสออกจากการฟอร์แมตใหม่โดยใช้แป้นพิมพ์ลัดต่างๆ

ประโยชน์ของการฟอร์แมตใหม่

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

• เยื้อง
• ฟังก์ชั่นสไตล์และการเขียน
• พื้นที่ว่าง.
• การใช้อักษรตัวพิมพ์ใหญ่และชื่อ

การดีบักถือเป็นความชั่วร้ายที่จำเป็นที่นักพัฒนาจะต้องเผชิญอยู่บ่อยครั้งตลอดอาชีพการงานของพวกเขา จะเริ่มต้นที่ไหนถ้า codebase ของคุณรกและไม่เป็นระเบียบ? เมื่อซอร์สโค้ดได้รับการจัดรูปแบบและเยื้องอย่างเหมาะสม จะปรากฏคลัสเตอร์น้อยลง ทำให้ง่ายต่อการระบุตำแหน่งของโมดูลแอปพลิเคชันต่างๆ ส่งผลให้สามารถค้นหาปัญหาและข้อผิดพลาดได้ง่ายขึ้น การจัดรูปแบบโค้ดใหม่ใน IntelliJ IDEA ขึ้นอยู่กับข้อกำหนดที่ระบุไว้ในการตั้งค่ารูปแบบโค้ดใน IDE แม้ว่าเมื่อคุณใช้EditorConfigในโปรเจ็กต์ของคุณ การตั้งค่าที่คุณระบุในไฟล์ .editorconfig จะแทนที่การตั้งค่าที่ระบุในการตั้งค่ารูปแบบโค้ดโดยค่าเริ่มต้น การฟอร์แมตใหม่ใน IntelliJ ก็ไม่แตกต่างจากการทำงานใน IDE อื่นๆ มีตัวเลือกในการฟอร์แมตทั้งโค้ดบล็อกเดียวและทั้งไฟล์ อาจมีบางครั้งที่โค้ดทั้งหมดของคุณค่อนข้างยาว และคุณต้องการให้ทุกอย่างได้รับการฟอร์แมตใหม่ ยกเว้นเฉพาะบางพื้นที่เท่านั้น ในกรณีนี้ การเลือกแต่ละส่วนของโค้ดที่คุณต้องการจัดรูปแบบไม่ใช่ตัวเลือกที่ดีที่สุดอย่างแน่นอน ในสถานการณ์เช่นนี้ การฟอร์แมตใหม่ด้วย IntelliJ จะมีประโยชน์อย่างแน่นอน เราจะสำรวจสิ่งนี้และการใช้งาน IDE อื่นๆ

คำแนะนำในการจัดรูปแบบโค้ด

มาดูเคล็ดลับพื้นฐานสำหรับการจัดรูปแบบโค้ดโดยทั่วไป:

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

• อย่าใช้แท็บเพื่อเว้นวรรคในบรรทัดเดียวกัน ซึ่งจะช่วยลดความสามารถในการอ่านโค้ด

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

• อย่าใช้การจัดรูปแบบโค้ดใหม่เพื่อแก้ไขข้อผิดพลาดทางไวยากรณ์อย่างรวดเร็ว

• หลีกเลี่ยงการลงทุนลึก นี่เป็นวิธีปฏิบัติทั่วไปสำหรับนักพัฒนาบางคน แต่โค้ดที่ซ้อนกันลึกทำให้อ่านได้ยากและทำให้เกิดข้อผิดพลาดที่ไม่ง่ายที่จะตรวจพบเมื่อมองแวบแรก

การจัดรูปแบบโค้ดใหม่ใน IntelliJ IDEA

ก่อนที่เราจะสำรวจวิธีต่างๆ ในการจัดรูปแบบโค้ดใน IntelliJ ให้เริ่มต้นด้วยการสร้างโปรเจ็กต์ Java ตัวอย่างใน IDE ของคุณ เมื่อคุณเปิดใช้งาน IntelliJ คุณจะเห็นหน้าจอดังนี้: คลิกถัดไปและดำเนินการตั้งค่าการเริ่มต้นโปรเจ็กต์ให้เสร็จสิ้น ตอนนี้โปรเจ็กต์ของคุณได้รับการตั้งค่าแล้ว ก็ถึงเวลาเพิ่มโค้ดตัวอย่างเพื่อช่วยให้คุณเข้าใจการจัดรูปแบบโค้ดใน IntelliJ นี่คือ ตัวนับคำศัพท์ง่ายๆจาก University of Texas:

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.Scanner;
import java.util.TreeMap;

public class SimpleWordCounter {

    public static void main(String[] args) {
        try {
            File f = new File("ciaFactBook2008.txt");
            Scanner sc;
            sc = new Scanner(f);
            // sc.useDelimiter("[^a-zA-Z']+");
            Map<String, Integer> wordCount = new TreeMap<String, Integer>();
            while(sc.hasNext()) {
                String word = sc.next();
                if(!wordCount.containsKey(word))
                    wordCount.put(word, 1);
                else
                    wordCount.put(word, wordCount.get(word) + 1);
            }

            // show results
            for(String word : wordCount.keySet())
                System.out.println(word + " " + wordCount.get(word));
            System.out.println(wordCount.size());
        }
        catch(IOException e) {
            System.out.println("Unable to read from file.");
        }
    }
}

การจัดรูปแบบข้อมูลโค้ดใหม่

เริ่มต้นด้วยการจัดรูปแบบข้อมูลโค้ด ในการดำเนินการนี้ เพียงไฮไลต์ส่วนของโค้ดที่คุณต้องการจัดรูปแบบแล้วคลิกโค้ด > ฟอร์แมตโค้ดใหม่ อย่างที่คุณเห็น ส่วนที่ไฮไลต์ของโค้ดของคุณ (ในกรณีนี้คือบรรทัดที่ 11-17) มีการจัดรูปแบบอย่างถูกต้อง มาดู "ก่อน" และ "หลัง" ของการจัดรูปแบบข้อมูลโค้ดของเราใหม่ หากคุณสังเกตเห็นในภาพแรก การประกาศและการกำหนดค่าเริ่มต้นของตัวแปรของคุณเกิดขึ้นในบรรทัดเดียวกับtry เครื่องหมายปีกกาปิดผสมกับ บล็อก else แต่หลังจากไฮไลต์ส่วนนี้ของโค้ดของคุณและใช้ตัวเลือกการจัดรูปแบบใหม่แล้ว คุณจะพบกับกลุ่มโค้ดที่ดูสบายตายิ่งขึ้น ตอนนี้โค้ดที่สมบูรณ์สำหรับชั้นเรียนของคุณมีลักษณะดังนี้: โปรดสังเกตว่าเฉพาะบล็อกโค้ดที่คุณเลือกเท่านั้นที่ได้รับการฟอร์แมตใหม่

การฟอร์แมตไฟล์ทั้งหมดใหม่

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

การฟอร์แมตโมดูลหรือไดเร็กทอรีใหม่

ในการดำเนินการนี้ สิ่งที่คุณต้องทำคือคลิกขวาที่โมดูลในหน้าต่างเครื่องมือโปรเจ็กต์ และเลือกReformat Code ในหน้าต่างป๊อปอัป ให้เลือกหนึ่งในสามตัวเลือกที่คุณต้องการ:

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

• จัดเรียงรายการใหม่ : เพื่อจัดระเบียบโค้ดใหม่ตามกฎเค้าโครงที่ระบุในการตั้งค่าสไตล์โค้ด

• รหัสการล้างข้อมูล : เพื่อเรียกใช้การล้างรหัส

เมื่อเสร็จแล้ว เพียงคลิกตกลง

ไม่รวมโค้ดจากการฟอร์แมตใหม่

มาดูกันว่าจะทำอย่างไรถ้าคุณมีบล็อกโค้ดที่คุณไม่ต้องการรวมไว้เมื่อจัดรูปแบบไฟล์ทั้งหมด ไปที่ไฟล์ > การตั้งค่า หรือใช้ แป้นพิมพ์ลัด Ctrl + Alt + S ไปที่Editor > Code Styleและทำเครื่องหมายที่ Enable formatter markers ในเมนูความคิดเห็นบน แท็บ Formatter Control ในตัวแก้ไขของคุณ ให้สร้างความคิดเห็นบรรทัดแล้วพิมพ์//@formatter:offโดยไม่มีเครื่องหมายคำพูดที่จุดเริ่มต้นของพื้นที่ที่คุณต้องการแยกออก ที่ท้ายพื้นที่ ให้สร้างความคิดเห็นอีกบรรทัดแล้วป้อน//@formatter:onโดยไม่ต้องใส่เครื่องหมายคำพูด ในภาพด้านบน คุณจะเห็นว่าฟอร์แมตเตอร์จะไม่สนใจโค้ดของคุณในบรรทัด 23 เพียงเพราะคุณระบุไว้ในความคิดเห็นและตัวควบคุมรูปแบบ

ตัวอย่างปุ่มลัดสำหรับการฟอร์แมตใหม่

• ฟอร์แมตบล็อกโค้ด: Ctrl + Alt + Shift + L
• ฟอร์แมตไฟล์: Ctrl + Alt + L
• เพิ่มความคิดเห็นในบรรทัด: Ctrl + /
• เพิ่มความคิดเห็นของบล็อก: Ctrl + Shift + /

บทสรุป

การใส่ใจกับรูปแบบโค้ดมีความสำคัญสำหรับนักพัฒนาพอๆ กับการทำให้มันใช้งานได้ คุณไม่สามารถบอกได้ว่าใครจะมาทำงานกับโค้ดของคุณ การมีฐานโค้ดที่อ่านง่ายและมีโครงสร้างที่ดีบ่งบอกถึงนักพัฒนามืออาชีพ ด้วย IntelliJ IDEA การจัดรูปแบบโค้ดของคุณไม่จำเป็นต้องยากเท่ากับการเขียนโค้ดด้วยตัวมันเอง ครั้งต่อไปที่คุณเขียนโค้ดโดยใช้ IntelliJ ให้ใช้เคล็ดลับเหล่านี้ สิ่งนี้จะทำให้ชีวิตของคุณง่ายขึ้นเมื่อทำการดีบั๊กโค้ดของคุณ