如何在 IntelliJ IDEA 中去掉 Java 方法注释后的空行

文章目录

[如何在 IntelliJ IDEA 中去掉 Java 方法注释后的空行](#如何在 IntelliJ IDEA 中去掉 Java 方法注释后的空行)
步骤
方法注释格式化的默认行为
为什么需要去掉这些空行？
修改后的效果
小结

在现代 Java 编程中，Javadoc 注释是不可或缺的一部分。它们不仅有助于开发人员理解代码的意图和功能，还能够通过工具生成文档，提升代码的可读性和维护性。然而，在代码格式化时，IntelliJ IDEA 有时会自动在方法注释和 @param、@return 等标签之间插入额外的空行，这种格式化可能并不符合一些开发团队或个人的代码规范。

本文将详细介绍如何在 IntelliJ IDEA 中去掉 Java 方法注释后多余的空行。我们将逐步深入探讨相关的设置和方法，确保你可以根据自己的需求调整 IDE 的行为，提升代码的整洁性与一致性。

步骤

打开 Settings（或 Preferences）。
进入 Editor > Code Style > Java。
点击右上角的 JavaDoc 按钮进入 Javadoc 设置。
取消勾选 Blank lines 下的 After description 选项。
点击 Apply 或 OK 保存设置。

方法注释格式化的默认行为

在默认情况下，IntelliJ IDEA 会自动格式化 Java 代码中的 Javadoc 注释。当你编写一个方法注释并按 Ctrl + Alt + L（Windows/Linux）或 Cmd + Alt + L（Mac）进行格式化时，IDE 会按照默认的代码样式设置来调整注释格式。

举个例子，假设你有一个如下的 Java 方法和 Javadoc 注释：

java 复制代码

package sample;

public class Sample {
    /**
     * This is a method description that is long enough to exceed right margin.
     * <p>
     * Another paragraph of the description placed after blank line.
     * <p/>
     * Line with manual
     * line feed.
     *
     * @param i                  short named parameter description
     * @param longParameterName  long named parameter description
     * @param missingDescription
     * @return return description.
     * @throws XXXException description.
     * @throws YException   description.
     * @throws ZException
     * @invalidTag
     */
    public abstract String sampleMethod(int i, int longParameterName, int missingDescription) throws XXXException, YException, ZException;

    /**
     * One-line comment
     */
    public abstract String sampleMethod2();

    /**
     * Simple method description
     *
     * @return
     */
    public abstract String sampleMethod3();
}

默认情况下，IDE 会在 @param 标签和描述文本之间插入一个空行。类似的格式化会出现在 @return 标签和方法返回值的描述之间。

为什么需要去掉这些空行？

对于一些开发者和团队来说，这种自动插入的空行并不是最佳的格式。通常，去掉这些空行可以使 Javadoc 看起来更加紧凑，减少不必要的空间浪费，尤其是在注释内容较为简短时。例如，下面这种格式可能更符合某些开发者的偏好：

java 复制代码

    /**
     * Simple method description
     * @return
     */
    public abstract String sampleMethod3();

这使得注释更加简洁，避免了过多的空白行，在许多项目中，这种风格被认为是更加紧凑和清晰的。

修改后的效果

java 复制代码

package sample;

public class Sample {
    /**
     * This is a method description that is long enough to exceed right margin.
     * <p>
     * Another paragraph of the description placed after blank line.
     * <p/>
     * Line with manual
     * line feed.
     * @param i                  short named parameter description
     * @param longParameterName  long named parameter description
     * @param missingDescription
     * @return return description.
     * @throws XXXException description.
     * @throws YException   description.
     * @throws ZException
     * @invalidTag
     */
    public abstract String sampleMethod(int i, int longParameterName, int missingDescription) throws XXXException, YException, ZException;

    /**
     * One-line comment
     */
    public abstract String sampleMethod2();

    /**
     * Simple method description
     * @return
     */
    public abstract String sampleMethod3();
}

小结

通过本文的介绍，你已经掌握了如何在 IntelliJ IDEA 中去掉 Java 方法注释后不需要的空行。只需要进入代码样式设置，取消勾选 Blank line between description and tags 选项，你就可以轻松调整 Javadoc 注释的格式，让代码更加简洁、紧凑，符合你的个人或团队规范。