Files
doris/docs/zh-CN/developer-guide/java-format-code.md
2022-05-08 06:41:46 +08:00

2.0 KiB

title, language
title language
Java 代码格式化 zh-CN

Java 代码格式化

Doris 中 Java 部分代码的格式化工作通常有 IDE 来自动完成。这里仅列举通用格式规则,开发这需要根据格式规则,在不同 IDE 中设置对应的代码风格。

Import Order

org.apache.doris
<blank line>
com
<blank line>
org
<blank line>
java
<blank line>
javax
<blank line>
  • 禁止使用 import *
  • 禁止使用 import static

Checkstyle

现在的 CI 之中会有 formatter-check 进行代码格式化检测。

如果使用 IDEA 进行 Java 开发,请在设置中安装 Checkstyle-IDEA 插件。

Tools->CheckstyleConfiguration File 里点击 Use a local Checkstyle file,选择项目的 fe/check/checkstyle/checkstyle.xml 文件。

同时推荐使用 IDEA 的自动格式化功能。

Preferences->Editor->Code Style->Java 的配置标识点击 Import Scheme,点击 IntelliJ IDEA code style XML,选择项目的 build-support/IntelliJ-code-format.xml 文件。

如果使用 VS Code 进行 Java 开发,请安装 Checkstyle for Java 插件,按照文档里的说明和动图进行配置。