You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by yi...@apache.org on 2022/05/30 08:10:10 UTC
[incubator-doris] branch master updated: [enhancement](style): polish the `checkstyle` (#9767)
This is an automated email from the ASF dual-hosted git repository.
yiguolei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-doris.git
The following commit(s) were added to refs/heads/master by this push:
new 46e84d39df [enhancement](style): polish the `checkstyle` (#9767)
46e84d39df is described below
commit 46e84d39df3cdb9a388649cab9de494c1c73774a
Author: jakevin <30...@users.noreply.github.com>
AuthorDate: Mon May 30 16:10:04 2022 +0800
[enhancement](style): polish the `checkstyle` (#9767)
* [enhancement](style): cancel auto tab for Javadoc.
* *: fix review
---
build-support/IntelliJ-code-format.xml | 5 ++++-
.../public/images/idea-checkstyle-plugin-cn.png | Bin 0 -> 32979 bytes
.../public/images/idea-checkstyle-plugin-en.png | Bin 0 -> 28042 bytes
docs/en/developer-guide/java-format-code.md | 4 ++++
docs/zh-CN/developer-guide/java-format-code.md | 4 ++++
5 files changed, 12 insertions(+), 1 deletion(-)
diff --git a/build-support/IntelliJ-code-format.xml b/build-support/IntelliJ-code-format.xml
index d3614116c0..ae406e6116 100644
--- a/build-support/IntelliJ-code-format.xml
+++ b/build-support/IntelliJ-code-format.xml
@@ -18,6 +18,7 @@ under the License.
-->
<code_scheme name="Doris" version="173">
<JavaCodeStyleSettings>
+ <option name="LAYOUT_STATIC_IMPORTS_SEPARATELY" value="false" />
<option name="INSERT_INNER_CLASS_IMPORTS" value="true" />
<option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999" />
<option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999" />
@@ -32,10 +33,12 @@ under the License.
<emptyLine />
<package name="java" withSubpackages="true" static="false" />
<package name="javax" withSubpackages="true" static="false" />
+ <emptyLine />
</value>
</option>
<option name="ALIGN_MULTILINE_RECORDS" value="false" />
- <option name="ALIGN_TYPES_IN_MULTI_CATCH" value="false" />
+ <option name="JD_ALIGN_PARAM_COMMENTS" value="false" />
+ <option name="JD_ALIGN_EXCEPTION_COMMENTS" value="false" />
</JavaCodeStyleSettings>
<ScalaCodeStyleSettings>
<option name="MULTILINE_STRING_CLOSING_QUOTES_ON_NEW_LINE" value="true" />
diff --git a/docs/.vuepress/public/images/idea-checkstyle-plugin-cn.png b/docs/.vuepress/public/images/idea-checkstyle-plugin-cn.png
new file mode 100644
index 0000000000..2dea261d9e
Binary files /dev/null and b/docs/.vuepress/public/images/idea-checkstyle-plugin-cn.png differ
diff --git a/docs/.vuepress/public/images/idea-checkstyle-plugin-en.png b/docs/.vuepress/public/images/idea-checkstyle-plugin-en.png
new file mode 100644
index 0000000000..bcaa2e144e
Binary files /dev/null and b/docs/.vuepress/public/images/idea-checkstyle-plugin-en.png differ
diff --git a/docs/en/developer-guide/java-format-code.md b/docs/en/developer-guide/java-format-code.md
index ab80066ba1..d6ac64bfc9 100644
--- a/docs/en/developer-guide/java-format-code.md
+++ b/docs/en/developer-guide/java-format-code.md
@@ -58,6 +58,10 @@ Click the plus sign under Configuration File, select `Use a local Checkstyle fil
+**You can use `Checkstyle-IDEA` plugin to check `Checkstyle` of your code real-time.**
+
+
+
### 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
diff --git a/docs/zh-CN/developer-guide/java-format-code.md b/docs/zh-CN/developer-guide/java-format-code.md
index 09f05a2f05..37fa3dbd6e 100644
--- a/docs/zh-CN/developer-guide/java-format-code.md
+++ b/docs/zh-CN/developer-guide/java-format-code.md
@@ -56,6 +56,10 @@ standard java package
+**可以使用 `Checkstyle-IDEA` 插件来对代码进行 `Checkstyle` 检测**。
+
+
+
### VS Code
如果使用 VS Code 进行 Java 开发，请安装 `Checkstyle for Java` 插件，按照[文档](https://code.visualstudio.com/docs/java/java-linting)里的说明和动图进行配置。
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org