style: 统一请求参数、响应参数注释

2025-09-09 08:57:16 +08:00 · 2025-04-16 21:46:08 +08:00
parent 283a5e0b93
commit 4ae716c34f
89 changed files with 180 additions and 242 deletions
--- a/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/model/req/GenConfigReq.java
+++ b/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/model/req/GenConfigReq.java
@@ -30,13 +30,13 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- * 代码生成配置信息
+ * 代码生成配置请求参数
 *
 * @author Charles7c
 * @since 2023/8/8 20:40
 */
@Data
-@Schema(description = "代码生成配置信息")
+@Schema(description = "代码生成配置请求参数")
 public class GenConfigReq implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/model/resp/GeneratePreviewResp.java
+++ b/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/model/resp/GeneratePreviewResp.java
@@ -24,13 +24,13 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 生成预览信息
+ * 生成预览响应参数
 *
 * @author Charles7c
 * @since 2023/12/19 21:34
 */
@Data
-@Schema(description = "生成预览信息")
+@Schema(description = "生成预览响应参数")
 public class GeneratePreviewResp implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-generator/src/main/resources/templates/backend/Req.ftl
+++ b/continew-plugin/continew-plugin-generator/src/main/resources/templates/backend/Req.ftl
@@ -24,13 +24,13 @@ import java.math.BigDecimal;
 </#if>

 /**
- * 创建或修改${businessName}参数
+ * ${businessName}创建或修改参数
 *
 * @author ${author}
 * @since ${datetime}
 */
@Data
-@Schema(description = "创建或修改${businessName}参数")
+@Schema(description = "${businessName}创建或修改参数")
 public class ${className} implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/model/req/AppReq.java
+++ b/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/model/req/AppReq.java
@@ -28,14 +28,14 @@ import java.io.Serializable;
 import java.time.LocalDateTime;

 /**
- * 创建或修改应用参数
+ * 应用创建或修改请求参数
 *
 * @author chengzi
 * @author Charles7c
 * @since 2024/10/17 16:03
 */
@Data
-@Schema(description = "创建或修改应用参数")
+@Schema(description = "应用创建或修改请求参数")
 public class AppReq implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/model/resp/AppDetailResp.java
+++ b/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/model/resp/AppDetailResp.java
@@ -28,7 +28,7 @@ import java.io.Serial;
 import java.time.LocalDateTime;

 /**
- * 应用详情信息
+ * 应用详情响应参数
 *
 * @author chengzi
 * @author Charles7c
@@ -36,7 +36,7 @@ import java.time.LocalDateTime;
 */
@Data
@ExcelIgnoreUnannotated
-@Schema(description = "应用详情信息")
+@Schema(description = "应用详情响应参数")
 public class AppDetailResp extends BaseDetailResp {

    @Serial
--- a/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/model/resp/AppResp.java
+++ b/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/model/resp/AppResp.java
@@ -25,14 +25,14 @@ import java.io.Serial;
 import java.time.LocalDateTime;

 /**
- * 应用信息
+ * 应用响应参数
 *
 * @author chengzi
 * @author Charles7c
 * @since 2024/10/17 16:03
 */
@Data
-@Schema(description = "应用信息")
+@Schema(description = "应用响应参数")
 public class AppResp extends BaseDetailResp {

    @Serial
--- a/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/model/resp/AppSecretResp.java
+++ b/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/model/resp/AppSecretResp.java
@@ -23,14 +23,14 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 应用密钥信息
+ * 应用密钥响应参数
 *
 * @author chengzi
 * @author Charles7c
 * @since 2024/10/17 16:03
 */
@Data
-@Schema(description = "应用密钥信息")
+@Schema(description = "应用密钥响应参数")
 public class AppSecretResp implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/JobInstanceLogPageResult.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/JobInstanceLogPageResult.java
@@ -24,13 +24,13 @@ import java.io.Serializable;
 import java.util.List;

 /**
- * 任务实例日志分页信息
+ * 任务实例日志分页响应参数
 *
 * @author Charles7c
 * @since 2024/7/14 21:51
 */
@Data
-@Schema(description = "任务实例日志分页信息")
+@Schema(description = "任务实例日志分页响应参数")
 public class JobInstanceLogPageResult implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/JobPageResult.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/JobPageResult.java
@@ -20,7 +20,7 @@ import com.aizuda.snailjob.common.core.model.Result;
 import lombok.Data;

 /**
- * 任务调度服务端分页返回对象
+ * 任务调度服务端分页响应参数
 *
 * @author KAI
 * @author Charles7c
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/req/JobReq.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/req/JobReq.java
@@ -27,14 +27,14 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 创建或修改任务参数
+ * 任务创建或修改请求参数
 *
 * @author KAI
 * @author Charles7c
 * @since 2024/6/25 16:40
 */
@Data
-@Schema(description = "创建或修改任务参数")
+@Schema(description = "任务创建或修改请求参数")
 public class JobReq implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/req/JobStatusReq.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/req/JobStatusReq.java
@@ -25,14 +25,14 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 修改任务状态信息
+ * 任务状态修改请求参数
 *
 * @author KAI
 * @author Charles7c
 * @since 2024/6/27 9:24
 */
@Data
-@Schema(description = "修改任务状态信息")
+@Schema(description = "任务状态修改请求参数")
 public class JobStatusReq implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/req/JobTriggerReq.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/req/JobTriggerReq.java
@@ -24,13 +24,13 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 执行任务参数
+ * 任务执行请求参数
 *
 * @author Charles7c
 * @since 2025/3/26 21:50
 */
@Data
-@Schema(description = "执行任务参数")
+@Schema(description = "任务执行请求参数")
 public class JobTriggerReq implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/resp/JobInstanceResp.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/resp/JobInstanceResp.java
@@ -23,14 +23,14 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 任务实例信息
+ * 任务实例响应参数
 *
 * @author KAI
 * @author Charles7c
 * @since 2024/6/28 16:58
 */
@Data
-@Schema(description = "任务实例信息")
+@Schema(description = "任务实例响应参数")
 public class JobInstanceResp implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/resp/JobLogResp.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/resp/JobLogResp.java
@@ -26,14 +26,14 @@ import java.io.Serializable;
 import java.time.LocalDateTime;

 /**
- * 任务日志信息
+ * 任务日志响应参数
 *
 * @author KAI
 * @author Charles7c
 * @since 2024/6/27 22:50
 */
@Data
-@Schema(description = "任务日志信息")
+@Schema(description = "任务日志响应参数")
 public class JobLogResp implements Serializable {

    @Serial
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/resp/JobResp.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/model/resp/JobResp.java
@@ -25,14 +25,14 @@ import java.io.Serializable;
 import java.time.LocalDateTime;

 /**
- * 任务信息
+ * 任务响应参数
 *
 * @author KAI
 * @author Charles7c
 * @since 2024/6/25 17:15
 */
@Data
-@Schema(description = "任务信息")
+@Schema(description = "任务响应参数")
 public class JobResp implements Serializable {

    @Serial