diff --git a/.github/workflows/clang-format.yml b/.github/workflows/clang-format.yml index af9758f627..eafd2ab313 100644 --- a/.github/workflows/clang-format.yml +++ b/.github/workflows/clang-format.yml @@ -17,11 +17,11 @@ # --- -name: BE Code Fomatter +name: BE Code Formatter on: pull_request jobs: clang-format: - name: "Clang Fomatter" + name: "Clang Formatter" runs-on: ubuntu-latest steps: - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )" diff --git a/docs/en/developer-guide/java-format-code.md b/docs/en/developer-guide/java-format-code.md index d3eb31c2cd..6842c75418 100644 --- a/docs/en/developer-guide/java-format-code.md +++ b/docs/en/developer-guide/java-format-code.md @@ -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. diff --git a/docs/zh-CN/developer-guide/java-format-code.md b/docs/zh-CN/developer-guide/java-format-code.md index daf62ea111..8819c4adb8 100644 --- a/docs/zh-CN/developer-guide/java-format-code.md +++ b/docs/zh-CN/developer-guide/java-format-code.md @@ -45,3 +45,14 @@ javax * 禁止使用 `import *` * 禁止使用 `import static` + +## Checkstyle + +现在的 `CI` 之中会有 `formatter-check` 进行代码格式化检测。 + +如果使用 `IDEA` 进行 Java 开发,请在设置中安装 `Checkstyle-IDEA` 插件。 + +在 `Tools->Checkstyle` 的 `Configuration File` 里点击 `Use a local Checkstyle file`,选择项目的 `fe/checkstyle.xml` 文件。 + +如果使用 VS Code 进行 Java 开发,请安装 `Checkstyle for Java` 插件,按照[文档](https://code.visualstudio.com/docs/java/java-linting)里的说明和动图进行配置。 +