database/doris
2
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity
Files
0c4b47756ad693db316d311e69ceed03d9f83161
doris/docs/zh-CN/developer-guide/java-format-code.md
jakevin 0c4b47756a [enhancement](community): enhance java style (#9693) 
Enhance java style.

Now: checkstyle about code order is in this page--Class and Interface Declarations

This pr can make idea auto rearrange code
2022-05-20 15:24:30 +08:00

2.4 KiB
Raw Blame History

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

Java 代码格式化

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

Import Order

org.apache.doris
<blank line>
third party package
<blank line>
standard java package
<blank line>
  • 禁止使用 import *
  • 禁止使用 import static

Checkstyle 插件

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

IDEA

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

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

VS Code

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

IDEA

自动格式化

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

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

Rearrange Code

Checkstyle 会按照 Class and Interface Declarations 检测代码的 declarations 顺序。

在导入上面的 build-support/IntelliJ-code-format.xml 文件后，使用 Code/Rearrange Code 自动完成排序