database/doris
2
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

[docs] add java formatter in doc (#7306)

Browse Source 
Now there isn't the guidance of java format. We should add it in doc.
This commit is contained in:
jakevin
2021-12-08 20:49:45 +08:00
committed by GitHub
parent 6f91741628
commit be0cf51eed
3 changed files with 25 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/en/developer-guide/java-format-code.md
View File

@ -45,3 +45,15 @@ javax
* Do not use `import *`
* Do not use `import static`
## Checkstyle
Now we have `formatter-check` in `CI` to check the code format.
If you use `IDEA` to develop Java code, please install `Checkstyle-IDEA` plugin.
Setting the `checkstyle.xml` file in `Tools->Checkstyle`.
Click the plus sign under Configuration File, Select `Use a local Checkstyle file`, and select the `fe/checkstyle.xml` file.
If you use VS Code to develop Java code, please install `Checkstyle for Java` plugin, and config according to the [document](https://code.visualstudio.com/docs/java/java-linting) and the picture.