喝咖啡休息#86。在 IntelliJ IDEA 中重新格式化程式碼的快速簡單指南

來源：Lightrun 身為開發人員，您必須對程式碼庫進行變更。如果程式碼庫的格式不明確，那麼偵錯對您來說將變得更加困難。 像重新格式化和程式碼中適當縮排這樣的小變化通常會被忽視，但它們顯然有助於區分專業開發人員的程式碼庫和初學者的程式碼庫。保持正確的程式碼格式和縮排將幫助您編寫更易於閱讀的程式碼。這簡化了專案協作，提高了調試和維護程式碼庫的速度。程式碼變得更具可讀性和結構化。是否可以加快程式碼重新格式化過程？本文將向您介紹一種使用 IntelliJ IDEA 自動重新格式化程式碼的簡單方法。您將了解如何減少此過程所需的時間，也將了解如何使用各種鍵盤快速鍵排除部分程式碼庫的重新格式化。

重新格式化的好處

重要的是要記住，該函數不需要格式化或註釋程式碼即可運行。任何程式碼，無論有沒有格式化，都可以被編譯器完全讀取和執行。另一方面，重新格式化使人們更容易閱讀標記。對於編譯器來說，重要的是程式碼是否有效且不包含錯誤，而不是程式碼有多好或縮排有多漂亮。確實，後者讓人們擔心，因為他們必須閱讀這樣的程式碼。就像純文字一樣，沒有人喜歡閱讀沒有標題、段落或任何縮排的無形內容。一些必要的重新格式化技術包括：

• 縮排。
• 風格和書寫功能。
• 空的空間。
• 使用大寫字母和名稱。

調試是開發人員在職業生涯中經常遇到的不可避免的問題。如果您的程式碼庫混亂無序，從哪裡開始？當原始程式碼的格式和縮排正確時，它看起來就不那麼聚集了。這使得更容易確定不同應用程式模組的位置。因此，更容易發現問題和錯誤。IntelliJ IDEA 中的程式碼重新格式化基於 IDE 中程式碼樣式設定中指定的要求。不過，當您在專案中使用EditorConfig時，您在 .editorconfig 檔案中指定的設定將預設覆寫程式碼樣式設定中指定的設定。在 IntelliJ 中重新格式化與在其他 IDE 中工作沒有什麼不同。有一些選項可以重新格式化單一程式碼區塊和整個檔案。有時，您的整個程式碼區塊可能相當長，並且您希望除了少數特定區域之外的所有內容都重新格式化。在這種情況下，單獨選擇要格式化的程式碼部分絕對不是最好的選擇。在這種情況下，使用 IntelliJ 重新格式化肯定會派上用場。我們將探討 IDE 的這項用途和其他用途。

格式化程式碼的提示

讓我們來看看一般格式化程式碼的一些基本技巧：

• 確保您的程式碼被正確註釋。使用註釋來傳達意圖和意義。即使您是唯一閱讀此程式碼的人，提醒自己某些程式碼區塊的用途仍然很有用。例如，如果您在假期後返回程式碼庫，這將使事情變得更容易。

• 請勿在同一行中使用製表符作為空格。這降低了程式碼的可讀性。

• 將 TODO 添加到程式碼區塊中以追蹤未來的實現。這樣，當您重新格式化程式碼時，就不會產生您的工作已完成的錯覺。

• 不要使用程式碼重新格式化來快速修復語法錯誤。

• 避免深度投資。這是一些開發人員的常見做法，但深度嵌套的程式碼使其難以閱讀，並且會引入乍一看不易發現的錯誤。

在 IntelliJ IDEA 中重新格式化程式碼

在我們探索在 IntelliJ 中格式化程式碼的不同方法之前，首先在 IDE 中建立一個範例 Java 專案。啟動 IntelliJ 後，您應該會看到以下畫面： 按一下「下一步」並完成專案初始化設定。 現在您的專案已設定完畢，是時候新增範例程式碼來幫助您了解 IntelliJ 中的程式碼重新格式化了。這是德克薩斯大學的 一個簡單的單字計數器：

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塊混合在一起。但是，在反白顯示這部分程式碼並使用重新格式化選項之後，您最終會得到一段更賞心悅目的程式碼區塊。您的類別的完整程式碼現在如下所示： 請注意，只有您選擇的程式碼區塊已重新格式化。

重新格式化整個文件

若要重新格式化整個文件，請開啟編輯器，將遊標放在任意位置，然後按一下Code >Reformat File。 系統將提示您為整個文件選擇適當的重新格式化選項。此操作將在活動編輯器中重新格式化所有程式碼。你的程式碼將變成這樣：

重新格式化模組或目錄

為此，您所需要做的就是右鍵單擊專案工具視窗中的模組並選擇Reformat Code。 在彈出視窗中，選擇您需要的三個選項中的任何一個：

• 最佳化導入：如果您想要新增缺少的導入語句並刪除未使用的導入，請選擇此選項。

• 重新排列條目：根據程式碼樣式設定中指定的佈局規則重新組織程式碼。

• 清理程式碼：運行程式碼清理。

完成後，只需按一下“確定”即可。

從重新格式化中排除程式碼

讓我們看看如果您在格式化整個文件時不想包含一段程式碼，該怎麼辦。前往「檔案」>「設定」或使用鍵盤快速鍵 Ctrl+Alt+S。前往「編輯器」>「程式碼樣式」 ，然後在「格式化程式控制」標籤上的註解選單中選取「啟用格式化程序標記” 。在編輯器中，建立行註解並在要排除的區域的開頭鍵入//@formatter:off （不含引號）。在該區域的末尾，建立另一行註解並輸入//@formatter:on，同樣不帶引號。 在上圖中，您可以看到格式化程式將忽略第 23 行的程式碼，因為您在註解和格式控制器中指定了它。

重新格式化熱鍵範例

• 重新格式化程式碼區塊：Ctrl + Alt + Shift + L
• 重新格式化檔案：Ctrl + Alt + L
• 在該行新增註解：Ctrl + /
• 新增區塊註解：Ctrl + Shift + /

結論

對於開發人員來說，專注於程式碼格式與使其正常運作同樣重要。您永遠無法知道誰最終會處理您的程式碼。擁有一個易於閱讀、結構良好的程式碼庫說明了一個專業的開發人員。借助 IntelliJ IDEA，格式化程式碼不必像編寫程式碼本身那麼困難。下次使用 IntelliJ 編寫程式碼時，請使用這些技巧。這將使您在調試程式碼時變得更加輕鬆。