[doc] Add a note about the version of checkstyle (#9785)

This commit is contained in:
Adonis Ling
2022-05-27 21:58:49 +08:00
committed by GitHub
parent ee1bed46be
commit cfe640c37b
3 changed files with 8 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

View File

@ -54,6 +54,10 @@ 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/check/checkstyle/checkstyle.xml` file.
**NOTE:** Make sure that the version of `Checkstyle` is 9.3 or newer (the latest version is recommended).
![](/images/idea-checkstyle-version.png)
### VS Code
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

View File

@ -52,6 +52,10 @@ standard java package
`Tools->Checkstyle``Configuration File` 里点击 `Use a local Checkstyle file`,选择项目的 `fe/check/checkstyle/checkstyle.xml` 文件。
**注意:** 保证`Checkstyle`的版本在9.3及以上(推荐使用最新版本)。
![](/images/idea-checkstyle-version.png)
### VS Code
如果使用 VS Code 进行 Java 开发,请安装 `Checkstyle for Java` 插件,按照[文档](https://code.visualstudio.com/docs/java/java-linting)里的说明和动图进行配置。