[Improve] Add code quality rules

apache · Oct 22, 2023 · 9408179 · 9408179
1 parent 39e82fc
commit 9408179
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git 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/...gin-content-docs-community/current/submit_guide/code-style-and-quality-guide.md b/...gin-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` 模块是处理用户请求的核心模块。