chore: 优化部分注释

2025-09-10 07:02:47 +08:00 · 2024-11-17 21:58:55 +08:00
parent 7870de2892
commit 3116836b01
26 changed files with 50 additions and 49 deletions
--- a/continew-module-system/src/main/java/top/continew/admin/auth/model/req/AccountLoginReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/auth/model/req/AccountLoginReq.java
@@ -24,13 +24,13 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 账号登录信息
+ * 账号登录参数
 *
 * @author Charles7c
 * @since 2022/12/21 20:43
 */
@Data
-@Schema(description = "账号登录信息")
+@Schema(description = "账号登录参数")
 public class AccountLoginReq implements Serializable {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/auth/model/req/EmailLoginReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/auth/model/req/EmailLoginReq.java
@@ -27,13 +27,13 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 邮箱登录信息
+ * 邮箱登录参数
 *
 * @author Charles7c
 * @since 2023/10/23 20:15
 */
@Data
-@Schema(description = "邮箱登录信息")
+@Schema(description = "邮箱登录参数")
 public class EmailLoginReq implements Serializable {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/auth/model/req/PhoneLoginReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/auth/model/req/PhoneLoginReq.java
@@ -27,13 +27,13 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 手机号登录信息
+ * 手机号登录参数
 *
 * @author Charles7c
 * @since 2023/10/26 22:37
 */
@Data
-@Schema(description = "手机号登录信息")
+@Schema(description = "手机号登录参数")
 public class PhoneLoginReq implements Serializable {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/DeptReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/DeptReq.java
@@ -28,13 +28,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
 import java.io.Serial;

 /**
- * 创建或修改部门信息
+ * 创建或修改部门参数
 *
 * @author Charles7c
 * @since 2023/1/24 00:21
 */
@Data
-@Schema(description = "创建或修改部门信息")
+@Schema(description = "创建或修改部门参数")
 public class DeptReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/DictItemReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/DictItemReq.java
@@ -28,13 +28,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
 import java.io.Serial;

 /**
- * 创建或修改字典项信息
+ * 创建或修改字典项参数
 *
 * @author Charles7c
 * @since 2023/9/11 21:29
 */
@Data
-@Schema(description = "创建或修改字典项信息")
+@Schema(description = "创建或修改字典项参数")
 public class DictItemReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/DictReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/DictReq.java
@@ -27,13 +27,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
 import java.io.Serial;

 /**
- * 创建或修改字典信息
+ * 创建或修改字典参数
 *
 * @author Charles7c
 * @since 2023/9/11 21:29
 */
@Data
-@Schema(description = "创建或修改字典信息")
+@Schema(description = "创建或修改字典参数")
 public class DictReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/FileReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/FileReq.java
@@ -25,13 +25,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
 import java.io.Serial;

 /**
- * 修改文件信息
+ * 修改文件参数
 *
 * @author Charles7c
 * @since 2023/12/23 10:38
 */
@Data
-@Schema(description = "修改文件信息")
+@Schema(description = "修改文件参数")
 public class FileReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/MenuReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/MenuReq.java
@@ -29,13 +29,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
 import java.io.Serial;

 /**
- * 创建或修改菜单信息
+ * 创建或修改菜单参数
 *
 * @author Charles7c
 * @since 2023/2/15 20:21
 */
@Data
-@Schema(description = "创建或修改菜单信息")
+@Schema(description = "创建或修改菜单参数")
 public class MenuReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/MessageReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/MessageReq.java
@@ -27,13 +27,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
 import java.io.Serial;

 /**
- * 创建消息信息
+ * 创建消息参数
 *
 * @author Bull-BCLS
 * @since 2023/10/15 19:05
 */
@Data
-@Schema(description = "创建消息信息")
+@Schema(description = "创建消息参数")
 public class MessageReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/NoticeReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/NoticeReq.java
@@ -30,13 +30,13 @@ import java.time.LocalDateTime;
 import java.util.List;

 /**
- * 创建或修改公告信息
+ * 创建或修改公告参数
 *
 * @author Charles7c
 * @since 2023/8/20 10:55
 */
@Data
-@Schema(description = "创建或修改公告信息")
+@Schema(description = "创建或修改公告参数")
 public class NoticeReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/OptionReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/OptionReq.java
@@ -26,13 +26,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
 import java.io.Serial;

 /**
- * 修改参数信息
+ * 修改参数参数
 *
 * @author Bull-BCLS
 * @since 2023/8/26 19:38
 */
@Data
-@Schema(description = "修改参数信息")
+@Schema(description = "修改参数参数")
 public class OptionReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/OptionResetValueReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/OptionResetValueReq.java
@@ -24,13 +24,13 @@ import java.io.Serializable;
 import java.util.List;

 /**
- * 参数重置信息
+ * 参数重置请求参数
 *
 * @author Bull-BCLS
 * @since 2023/9/21 23:10
 */
@Data
-@Schema(description = "参数重置信息")
+@Schema(description = "参数重置请求参数")
 public class OptionResetValueReq implements Serializable {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/RoleReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/RoleReq.java
@@ -31,13 +31,13 @@ import java.util.ArrayList;
 import java.util.List;

 /**
- * 创建或修改角色信息
+ * 创建或修改角色参数
 *
 * @author Charles7c
 * @since 2023/2/8 23:12
 */
@Data
-@Schema(description = "创建或修改角色信息")
+@Schema(description = "创建或修改角色参数")
 public class RoleReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/StorageReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/StorageReq.java
@@ -31,13 +31,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
 import java.io.Serial;

 /**
- * 存储请求信息
+ * 存储请求参数
 *
 * @author Charles7c
 * @since 2023/12/26 22:09
 */
@Data
-@Schema(description = "存储请求信息")
+@Schema(description = "存储请求参数")
 public class StorageReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserBasicInfoUpdateReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserBasicInfoUpdateReq.java
@@ -28,13 +28,13 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 用户基础信息修改信息
+ * 用户基础信息修改参数
 *
 * @author Charles7c
 * @since 2023/1/7 23:08
 */
@Data
-@Schema(description = "用户基础信息修改信息")
+@Schema(description = "用户基础信息修改参数")
 public class UserBasicInfoUpdateReq implements Serializable {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserEmailUpdateRequest.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserEmailUpdateRequest.java
@@ -27,13 +27,13 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 用户邮箱修改信息
+ * 用户邮箱修改参数
 *
 * @author Charles7c
 * @since 2023/1/12 20:18
 */
@Data
-@Schema(description = "用户邮箱修改信息")
+@Schema(description = "用户邮箱修改参数")
 public class UserEmailUpdateRequest implements Serializable {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserPasswordResetReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserPasswordResetReq.java
@@ -24,13 +24,13 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 用户密码重置信息
+ * 用户密码重置参数
 *
 * @author Charles7c
 * @since 2024/2/2 22:50
 */
@Data
-@Schema(description = "用户密码重置信息")
+@Schema(description = "用户密码重置参数")
 public class UserPasswordResetReq implements Serializable {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserPasswordUpdateReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserPasswordUpdateReq.java
@@ -24,13 +24,13 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 用户密码修改信息
+ * 用户密码修改参数
 *
 * @author Charles7c
 * @since 2023/1/9 23:28
 */
@Data
-@Schema(description = "用户密码修改信息")
+@Schema(description = "用户密码修改参数")
 public class UserPasswordUpdateReq implements Serializable {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserPhoneUpdateReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserPhoneUpdateReq.java
@@ -27,13 +27,13 @@ import java.io.Serial;
 import java.io.Serializable;

 /**
- * 用户手机号修改信息
+ * 用户手机号修改参数
 *
 * @author Charles7c
 * @since 2023/10/27 20:11
 */
@Data
-@Schema(description = "用户手机号修改信息")
+@Schema(description = "用户手机号修改参数")
 public class UserPhoneUpdateReq implements Serializable {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserReq.java
@@ -34,13 +34,13 @@ import java.io.Serial;
 import java.util.List;

 /**
- * 创建或修改用户信息
+ * 创建或修改用户参数
 *
 * @author Charles7c
 * @since 2023/2/20 21:03
 */
@Data
-@Schema(description = "创建或修改用户信息")
+@Schema(description = "创建或修改用户参数")
 public class UserReq extends BaseReq {

    @Serial
--- a/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserRoleUpdateReq.java
+++ b/continew-module-system/src/main/java/top/continew/admin/system/model/req/user/UserRoleUpdateReq.java
@@ -25,13 +25,13 @@ import java.io.Serializable;
 import java.util.List;

 /**
- * 用户角色修改信息
+ * 用户角色修改参数
 *
 * @author Charles7c
 * @since 2023/2/24 23:05
 */
@Data
-@Schema(description = "用户角色修改信息")
+@Schema(description = "用户角色修改参数")
 public class UserRoleUpdateReq 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
@@ -21,13 +21,13 @@ import org.hibernate.validator.constraints.Length;
 import top.continew.starter.extension.crud.model.req.BaseReq;

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

    @Serial
--- a/continew-plugin/continew-plugin-generator/src/main/resources/templates/frontend/index.ftl
+++ b/continew-plugin/continew-plugin-generator/src/main/resources/templates/frontend/index.ftl
@@ -145,8 +145,9 @@ const columns: TableInstanceColumns[] = [
 </#if>
  {
    title: '操作',
+    dataIndex: 'action',
    slotName: 'action',
-    width: 130,
+    width: 160,
    align: 'center',
    fixed: !isMobile() ? 'right' : undefined,
    show: has.hasPermOr(['${apiModuleName}:${apiName}:detail', '${apiModuleName}:${apiName}:update', '${apiModuleName}:${apiName}:delete'])
--- 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-webapi/src/main/java/top/continew/admin/controller/system/MenuController.java
+++ b/continew-webapi/src/main/java/top/continew/admin/controller/system/MenuController.java
@@ -62,7 +62,7 @@ public class MenuController extends BaseController<MenuService, MenuResp, MenuRe
    /**
     * 检查路由地址格式
     *
-     * @param req 创建或修改信息
+     * @param req 创建或修改参数
     */
    private void checkPath(MenuReq req) {
        Boolean isExternal = ObjectUtil.defaultIfNull(req.getIsExternal(), false);
--- a/continew-webapi/src/main/java/top/continew/admin/controller/system/NoticeController.java
+++ b/continew-webapi/src/main/java/top/continew/admin/controller/system/NoticeController.java
@@ -62,7 +62,7 @@ public class NoticeController extends BaseController<NoticeService, NoticeResp,
    /**
     * 校验
     *
-     * @param req 创建或修改信息
+     * @param req 创建或修改参数
     */
    private void check(NoticeReq req) {
        // 校验生效时间