This is an automated email from the ASF dual-hosted git repository.
panyuepeng pushed a commit to branch dev
in repository
https://gitbox.apache.org/repos/asf/incubator-streampark-website.git
The following commit(s) were added to refs/heads/dev by this push:
new a7294372 [Improve] Add code quality rules (#276)
a7294372 is described below
commit a72943726ec5dee9d0176fcce9a41d80bc83ffc0
Author: ChunFuWu <[email protected]>
AuthorDate: Mon Oct 23 14:15:05 2023 +0800
[Improve] Add code quality rules (#276)
---
.../submit_guide/code-style-and-quality-guide.md | 20 ++++++++++++++++++++
.../submit_guide/code-style-and-quality-guide.md | 20 ++++++++++++++++++++
2 files changed, 40 insertions(+)
diff --git a/community/submit_guide/code-style-and-quality-guide.md
b/community/submit_guide/code-style-and-quality-guide.md
index 6a6eb322..0c3dbde9 100644
--- a/community/submit_guide/code-style-and-quality-guide.md
+++ b/community/submit_guide/code-style-and-quality-guide.md
@@ -527,6 +527,26 @@ to reduce code line depth and improve readability like
follows:
}
```
+### 3.13 `Deprecated` Annotation
+
+ - Negative demo:
+
+ ```java
+ @deprecated
+ public void process(String input) {
+ ...
+ }
+ ```
+
+ - Positive demo:
+
+ ```java
+ @Deprecated
+ public void process(String input) {
+ ...
+ }
+ ```
+
## 4 Exception Processing
This `streampark-console-service` module is the core module for processing
user requests.
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/code-style-and-quality-guide.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/code-style-and-quality-guide.md
index c16c5d10..6b5d120d 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/code-style-and-quality-guide.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/submit_guide/code-style-and-quality-guide.md
@@ -527,6 +527,26 @@ sidebar_position: 3
}
```
+### 3.13 `Deprecated` 注解
+
+ - 负面示例:
+
+ ```java
+ @deprecated
+ public void process(String input) {
+ ...
+ }
+ ```
+
+ - 正面示例:
+
+ ```java
+ @Deprecated
+ public void process(String input) {
+ ...
+ }
+ ```
+
## 4 异常处理
`streampark-console-service` 模块是处理用户请求的核心模块。