chore: 优化部分注释

This commit is contained in:
2024-11-17 21:58:55 +08:00
parent 7870de2892
commit 3116836b01
26 changed files with 50 additions and 49 deletions

View File

@@ -24,13 +24,13 @@ import java.io.Serial;
import java.io.Serializable; import java.io.Serializable;
/** /**
* 账号登录信息 * 账号登录参数
* *
* @author Charles7c * @author Charles7c
* @since 2022/12/21 20:43 * @since 2022/12/21 20:43
*/ */
@Data @Data
@Schema(description = "账号登录信息") @Schema(description = "账号登录参数")
public class AccountLoginReq implements Serializable { public class AccountLoginReq implements Serializable {
@Serial @Serial

View File

@@ -27,13 +27,13 @@ import java.io.Serial;
import java.io.Serializable; import java.io.Serializable;
/** /**
* 邮箱登录信息 * 邮箱登录参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/10/23 20:15 * @since 2023/10/23 20:15
*/ */
@Data @Data
@Schema(description = "邮箱登录信息") @Schema(description = "邮箱登录参数")
public class EmailLoginReq implements Serializable { public class EmailLoginReq implements Serializable {
@Serial @Serial

View File

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

View File

@@ -28,13 +28,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
import java.io.Serial; import java.io.Serial;
/** /**
* 创建或修改部门信息 * 创建或修改部门参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/1/24 00:21 * @since 2023/1/24 00:21
*/ */
@Data @Data
@Schema(description = "创建或修改部门信息") @Schema(description = "创建或修改部门参数")
public class DeptReq extends BaseReq { public class DeptReq extends BaseReq {
@Serial @Serial

View File

@@ -28,13 +28,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
import java.io.Serial; import java.io.Serial;
/** /**
* 创建或修改字典项信息 * 创建或修改字典项参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/9/11 21:29 * @since 2023/9/11 21:29
*/ */
@Data @Data
@Schema(description = "创建或修改字典项信息") @Schema(description = "创建或修改字典项参数")
public class DictItemReq extends BaseReq { public class DictItemReq extends BaseReq {
@Serial @Serial

View File

@@ -27,13 +27,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
import java.io.Serial; import java.io.Serial;
/** /**
* 创建或修改字典信息 * 创建或修改字典参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/9/11 21:29 * @since 2023/9/11 21:29
*/ */
@Data @Data
@Schema(description = "创建或修改字典信息") @Schema(description = "创建或修改字典参数")
public class DictReq extends BaseReq { public class DictReq extends BaseReq {
@Serial @Serial

View File

@@ -25,13 +25,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
import java.io.Serial; import java.io.Serial;
/** /**
* 修改文件信息 * 修改文件参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/12/23 10:38 * @since 2023/12/23 10:38
*/ */
@Data @Data
@Schema(description = "修改文件信息") @Schema(description = "修改文件参数")
public class FileReq extends BaseReq { public class FileReq extends BaseReq {
@Serial @Serial

View File

@@ -29,13 +29,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
import java.io.Serial; import java.io.Serial;
/** /**
* 创建或修改菜单信息 * 创建或修改菜单参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/2/15 20:21 * @since 2023/2/15 20:21
*/ */
@Data @Data
@Schema(description = "创建或修改菜单信息") @Schema(description = "创建或修改菜单参数")
public class MenuReq extends BaseReq { public class MenuReq extends BaseReq {
@Serial @Serial

View File

@@ -27,13 +27,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
import java.io.Serial; import java.io.Serial;
/** /**
* 创建消息信息 * 创建消息参数
* *
* @author Bull-BCLS * @author Bull-BCLS
* @since 2023/10/15 19:05 * @since 2023/10/15 19:05
*/ */
@Data @Data
@Schema(description = "创建消息信息") @Schema(description = "创建消息参数")
public class MessageReq extends BaseReq { public class MessageReq extends BaseReq {
@Serial @Serial

View File

@@ -30,13 +30,13 @@ import java.time.LocalDateTime;
import java.util.List; import java.util.List;
/** /**
* 创建或修改公告信息 * 创建或修改公告参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/8/20 10:55 * @since 2023/8/20 10:55
*/ */
@Data @Data
@Schema(description = "创建或修改公告信息") @Schema(description = "创建或修改公告参数")
public class NoticeReq extends BaseReq { public class NoticeReq extends BaseReq {
@Serial @Serial

View File

@@ -26,13 +26,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
import java.io.Serial; import java.io.Serial;
/** /**
* 修改参数信息 * 修改参数参数
* *
* @author Bull-BCLS * @author Bull-BCLS
* @since 2023/8/26 19:38 * @since 2023/8/26 19:38
*/ */
@Data @Data
@Schema(description = "修改参数信息") @Schema(description = "修改参数参数")
public class OptionReq extends BaseReq { public class OptionReq extends BaseReq {
@Serial @Serial

View File

@@ -24,13 +24,13 @@ import java.io.Serializable;
import java.util.List; import java.util.List;
/** /**
* 参数重置信息 * 参数重置请求参数
* *
* @author Bull-BCLS * @author Bull-BCLS
* @since 2023/9/21 23:10 * @since 2023/9/21 23:10
*/ */
@Data @Data
@Schema(description = "参数重置信息") @Schema(description = "参数重置请求参数")
public class OptionResetValueReq implements Serializable { public class OptionResetValueReq implements Serializable {
@Serial @Serial

View File

@@ -31,13 +31,13 @@ import java.util.ArrayList;
import java.util.List; import java.util.List;
/** /**
* 创建或修改角色信息 * 创建或修改角色参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/2/8 23:12 * @since 2023/2/8 23:12
*/ */
@Data @Data
@Schema(description = "创建或修改角色信息") @Schema(description = "创建或修改角色参数")
public class RoleReq extends BaseReq { public class RoleReq extends BaseReq {
@Serial @Serial

View File

@@ -31,13 +31,13 @@ import top.continew.starter.extension.crud.model.req.BaseReq;
import java.io.Serial; import java.io.Serial;
/** /**
* 存储请求信息 * 存储请求参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/12/26 22:09 * @since 2023/12/26 22:09
*/ */
@Data @Data
@Schema(description = "存储请求信息") @Schema(description = "存储请求参数")
public class StorageReq extends BaseReq { public class StorageReq extends BaseReq {
@Serial @Serial

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -34,13 +34,13 @@ import java.io.Serial;
import java.util.List; import java.util.List;
/** /**
* 创建或修改用户信息 * 创建或修改用户参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/2/20 21:03 * @since 2023/2/20 21:03
*/ */
@Data @Data
@Schema(description = "创建或修改用户信息") @Schema(description = "创建或修改用户参数")
public class UserReq extends BaseReq { public class UserReq extends BaseReq {
@Serial @Serial

View File

@@ -25,13 +25,13 @@ import java.io.Serializable;
import java.util.List; import java.util.List;
/** /**
* 用户角色修改信息 * 用户角色修改参数
* *
* @author Charles7c * @author Charles7c
* @since 2023/2/24 23:05 * @since 2023/2/24 23:05
*/ */
@Data @Data
@Schema(description = "用户角色修改信息") @Schema(description = "用户角色修改参数")
public class UserRoleUpdateReq implements Serializable { public class UserRoleUpdateReq implements Serializable {
@Serial @Serial

View File

@@ -21,13 +21,13 @@ import org.hibernate.validator.constraints.Length;
import top.continew.starter.extension.crud.model.req.BaseReq; import top.continew.starter.extension.crud.model.req.BaseReq;
/** /**
* 创建或修改${businessName}信息 * 创建或修改${businessName}参数
* *
* @author ${author} * @author ${author}
* @since ${datetime} * @since ${datetime}
*/ */
@Data @Data
@Schema(description = "创建或修改${businessName}信息") @Schema(description = "创建或修改${businessName}参数")
public class ${className} extends BaseReq { public class ${className} extends BaseReq {
@Serial @Serial

View File

@@ -145,8 +145,9 @@ const columns: TableInstanceColumns[] = [
</#if> </#if>
{ {
title: '操作', title: '操作',
dataIndex: 'action',
slotName: 'action', slotName: 'action',
width: 130, width: 160,
align: 'center', align: 'center',
fixed: !isMobile() ? 'right' : undefined, fixed: !isMobile() ? 'right' : undefined,
show: has.hasPermOr(['${apiModuleName}:${apiName}:detail', '${apiModuleName}:${apiName}:update', '${apiModuleName}:${apiName}:delete']) show: has.hasPermOr(['${apiModuleName}:${apiName}:detail', '${apiModuleName}:${apiName}:update', '${apiModuleName}:${apiName}:delete'])

View File

@@ -27,14 +27,14 @@ import java.io.Serial;
import java.io.Serializable; import java.io.Serializable;
/** /**
* 创建或修改任务信息 * 创建或修改任务参数
* *
* @author KAI * @author KAI
* @author Charles7c * @author Charles7c
* @since 2024/6/25 16:40 * @since 2024/6/25 16:40
*/ */
@Data @Data
@Schema(description = "创建或修改任务信息") @Schema(description = "创建或修改任务参数")
public class JobReq implements Serializable { public class JobReq implements Serializable {
@Serial @Serial

View File

@@ -62,7 +62,7 @@ public class MenuController extends BaseController<MenuService, MenuResp, MenuRe
/** /**
* 检查路由地址格式 * 检查路由地址格式
* *
* @param req 创建或修改信息 * @param req 创建或修改参数
*/ */
private void checkPath(MenuReq req) { private void checkPath(MenuReq req) {
Boolean isExternal = ObjectUtil.defaultIfNull(req.getIsExternal(), false); Boolean isExternal = ObjectUtil.defaultIfNull(req.getIsExternal(), false);

View File

@@ -62,7 +62,7 @@ public class NoticeController extends BaseController<NoticeService, NoticeResp,
/** /**
* 校验 * 校验
* *
* @param req 创建或修改信息 * @param req 创建或修改参数
*/ */
private void check(NoticeReq req) { private void check(NoticeReq req) {
// 校验生效时间 // 校验生效时间