喝咖啡休息#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 编写代码时，请使用这些技巧。这将使您在调试代码时变得更加轻松。