From bf3e1590fa975cd37330a2d79beb1872b967291e Mon Sep 17 00:00:00 2001
From: Charles7c <charles7c@126.com>
Date: Thu, 17 Apr 2025 21:57:09 +0800
Subject: [PATCH] =?UTF-8?q?style:=20=E7=BB=9F=E4=B8=80=E8=AF=B7=E6=B1=82?=
 =?UTF-8?q?=E5=8F=82=E6=95=B0=E3=80=81=E5=93=8D=E5=BA=94=E5=8F=82=E6=95=B0?=
 =?UTF-8?q?=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../admin/auth/service/AuthService.java         |  2 +-
 .../admin/system/service/FileService.java       | 10 ++++++----
 .../admin/system/service/MessageService.java    |  2 +-
 .../admin/system/service/RoleService.java       |  2 +-
 .../admin/system/service/UserService.java       |  4 ++--
 .../generator/service/GeneratorService.java     |  2 +-
 .../top/continew/admin/schedule/api/JobApi.java |  8 ++++----
 .../admin/schedule/service/JobService.java      |  8 ++++----
 .../controller/common/CaptchaController.java    | 17 +++++++++--------
 9 files changed, 29 insertions(+), 26 deletions(-)

diff --git a/continew-module-system/src/main/java/top/continew/admin/auth/service/AuthService.java b/continew-module-system/src/main/java/top/continew/admin/auth/service/AuthService.java
index 3289ebdf..3b61fc29 100644
--- a/continew-module-system/src/main/java/top/continew/admin/auth/service/AuthService.java
+++ b/continew-module-system/src/main/java/top/continew/admin/auth/service/AuthService.java
@@ -34,7 +34,7 @@ public interface AuthService {
     /**
      * 登录
      *
-     * @param req     登录请求参数
+     * @param req     请求参数
      * @param request 请求对象
      * @return 登录响应参数
      */
diff --git a/continew-module-system/src/main/java/top/continew/admin/system/service/FileService.java b/continew-module-system/src/main/java/top/continew/admin/system/service/FileService.java
index 028f8612..f616aa14 100644
--- a/continew-module-system/src/main/java/top/continew/admin/system/service/FileService.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/service/FileService.java
@@ -98,15 +98,17 @@ public interface FileService extends BaseService<FileResp, FileResp, FileQuery,
 
     /**
      * 检查文件是否存在
-     * @param fileHash
-     * @return
+     * 
+     * @param fileHash 文件 Hash
+     * @return 响应参数
      */
     FileResp check(String fileHash);
 
     /**
      * 创建目录
-     * @param req
-     * @return
+     * 
+     * @param req 请求参数
+     * @return ID
      */
     IdResp<Long> createDir(FileReq req);
 }
\ No newline at end of file
diff --git a/continew-module-system/src/main/java/top/continew/admin/system/service/MessageService.java b/continew-module-system/src/main/java/top/continew/admin/system/service/MessageService.java
index 1c305d8e..1fc27f45 100644
--- a/continew-module-system/src/main/java/top/continew/admin/system/service/MessageService.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/service/MessageService.java
@@ -44,7 +44,7 @@ public interface MessageService {
     /**
      * 新增
      *
-     * @param req        新增信息
+     * @param req        请求参数
      * @param userIdList 接收人列表
      */
     void add(MessageReq req, List<Long> userIdList);
diff --git a/continew-module-system/src/main/java/top/continew/admin/system/service/RoleService.java b/continew-module-system/src/main/java/top/continew/admin/system/service/RoleService.java
index 4ca15315..610c0fe9 100644
--- a/continew-module-system/src/main/java/top/continew/admin/system/service/RoleService.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/service/RoleService.java
@@ -41,7 +41,7 @@ public interface RoleService extends BaseService<RoleResp, RoleDetailResp, RoleQ
      * 修改角色权限
      *
      * @param id  角色 ID
-     * @param req 参数
+     * @param req 请求参数
      */
     void updatePermission(Long id, RoleUpdatePermissionReq req);
 
diff --git a/continew-module-system/src/main/java/top/continew/admin/system/service/UserService.java b/continew-module-system/src/main/java/top/continew/admin/system/service/UserService.java
index 383b67ed..3ce108f4 100644
--- a/continew-module-system/src/main/java/top/continew/admin/system/service/UserService.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/service/UserService.java
@@ -58,7 +58,7 @@ public interface UserService extends BaseService<UserResp, UserDetailResp, UserQ
     /**
      * 导入数据
      *
-     * @param req 导入信息
+     * @param req 请求参数
      * @return 导入结果
      */
     UserImportResp importUser(UserImportReq req);
@@ -66,7 +66,7 @@ public interface UserService extends BaseService<UserResp, UserDetailResp, UserQ
     /**
      * 重置密码
      *
-     * @param req 重置信息
+     * @param req 请求参数
      * @param id  ID
      */
     void resetPassword(UserPasswordResetReq req, Long id);
diff --git a/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/service/GeneratorService.java b/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/service/GeneratorService.java
index 883a42c0..10040d9f 100644
--- a/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/service/GeneratorService.java
+++ b/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/service/GeneratorService.java
@@ -66,7 +66,7 @@ public interface GeneratorService {
     /**
      * 保存代码生成配置信息
      *
-     * @param req       代码生成配置信息
+     * @param req       请求参数
      * @param tableName 表名称
      */
     void saveConfig(GenConfigReq req, String tableName);
diff --git a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/api/JobApi.java b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/api/JobApi.java
index eea5fd70..c807f649 100644
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/api/JobApi.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/api/JobApi.java
@@ -53,7 +53,7 @@ public interface JobApi {
     /**
      * 新增
      *
-     * @param req 新增信息
+     * @param req 请求参数
      * @return 响应信息
      */
     @PostMapping
@@ -62,7 +62,7 @@ public interface JobApi {
     /**
      * 修改
      *
-     * @param req 修改信息
+     * @param req 请求参数
      * @return 响应信息
      */
     @PutMapping
@@ -71,7 +71,7 @@ public interface JobApi {
     /**
      * 修改状态
      *
-     * @param req 修改信息
+     * @param req 请求参数
      * @return 响应信息
      */
     @PutMapping("/status")
@@ -89,7 +89,7 @@ public interface JobApi {
     /**
      * 执行
      *
-     * @param req 参数
+     * @param req 请求参数
      * @return 响应信息
      */
     @PostMapping("/trigger")
diff --git a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/service/JobService.java b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/service/JobService.java
index 62297d08..41514a48 100644
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/service/JobService.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/service/JobService.java
@@ -45,7 +45,7 @@ public interface JobService {
     /**
      * 新增
      *
-     * @param req 创建信息
+     * @param req 请求参数
      * @return 新增结果
      */
     boolean create(JobReq req);
@@ -53,7 +53,7 @@ public interface JobService {
     /**
      * 修改
      *
-     * @param req 修改信息
+     * @param req 请求参数
      * @param id  ID
      * @return 修改结果
      */
@@ -62,7 +62,7 @@ public interface JobService {
     /**
      * 修改状态
      *
-     * @param req 修改状态信息
+     * @param req 请求参数
      * @param id  ID
      * @return 修改状态结果
      */
@@ -79,7 +79,7 @@ public interface JobService {
     /**
      * 执行
      *
-     * @param req 参数
+     * @param req 请求参数
      * @return 执行结果
      */
     boolean trigger(JobTriggerReq req);
diff --git a/continew-webapi/src/main/java/top/continew/admin/controller/common/CaptchaController.java b/continew-webapi/src/main/java/top/continew/admin/controller/common/CaptchaController.java
index c6a31713..1ac39d08 100644
--- a/continew-webapi/src/main/java/top/continew/admin/controller/common/CaptchaController.java
+++ b/continew-webapi/src/main/java/top/continew/admin/controller/common/CaptchaController.java
@@ -131,12 +131,13 @@ public class CaptchaController {
      * <p>
      * 限流规则：<br>
      * 1.同一邮箱同一模板，1分钟2条，1小时8条，24小时20条 <br>
-     * 2、同一邮箱所有模板 24 小时 100 条 <br>
-     * 3、同一 IP 每分钟限制发送 30 条
+     * 2.同一邮箱所有模板 24 小时 100 条 <br>
+     * 3.同一 IP 每分钟限制发送 30 条
      * </p>
      *
-     * @param email 邮箱
-     * @return /
+     * @param email      邮箱
+     * @param captchaReq 行为验证码请求参数
+     * @return {@link R }
      */
     @Operation(summary = "获取邮箱验证码", description = "发送验证码到指定邮箱")
     @GetMapping("/mail")
@@ -177,13 +178,13 @@ public class CaptchaController {
      * <p>
      * 限流规则：<br>
      * 1.同一号码同一模板，1分钟2条，1小时8条，24小时20条 <br>
-     * 2、同一号码所有模板 24 小时 100 条 <br>
-     * 3、同一 IP 每分钟限制发送 30 条
+     * 2.同一号码所有模板 24 小时 100 条 <br>
+     * 3.同一 IP 每分钟限制发送 30 条
      * </p>
      *
      * @param phone      手机号
-     * @param captchaReq 行为验证码信息
-     * @return /
+     * @param captchaReq 行为验证码请求参数
+     * @return {@link R }
      */
     @Operation(summary = "获取短信验证码", description = "发送验证码到指定手机号")
     @GetMapping("/sms")