mirror of
https://github.com/continew-org/continew-starter.git
synced 2025-09-08 16:57:09 +08:00
chore: 优化代码注释
This commit is contained in:
@@ -19,9 +19,10 @@ package top.continew.starter.core.constant;
|
|||||||
/**
|
/**
|
||||||
* 字符相关常量
|
* 字符相关常量
|
||||||
*
|
*
|
||||||
|
* @see cn.hutool.core.text.CharPool
|
||||||
|
*
|
||||||
* @author looly(<a href="https://gitee.com/dromara/hutool">Hutool</a>)
|
* @author looly(<a href="https://gitee.com/dromara/hutool">Hutool</a>)
|
||||||
* @author Charles7c
|
* @author Charles7c
|
||||||
* @see cn.hutool.core.text.CharPool
|
|
||||||
* @since 2.7.3
|
* @since 2.7.3
|
||||||
*/
|
*/
|
||||||
public class CharConstants {
|
public class CharConstants {
|
||||||
|
@@ -19,9 +19,10 @@ package top.continew.starter.core.constant;
|
|||||||
/**
|
/**
|
||||||
* 字符串相关常量
|
* 字符串相关常量
|
||||||
*
|
*
|
||||||
|
* @see cn.hutool.core.text.StrPool
|
||||||
|
*
|
||||||
* @author looly(<a href="https://gitee.com/dromara/hutool">Hutool</a>)
|
* @author looly(<a href="https://gitee.com/dromara/hutool">Hutool</a>)
|
||||||
* @author Charles7c
|
* @author Charles7c
|
||||||
* @see cn.hutool.core.text.StrPool
|
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*/
|
*/
|
||||||
public class StringConstants {
|
public class StringConstants {
|
||||||
|
@@ -25,8 +25,9 @@ import java.util.function.BooleanSupplier;
|
|||||||
/**
|
/**
|
||||||
* 业务参数校验工具类(抛出 500 ServiceException)
|
* 业务参数校验工具类(抛出 500 ServiceException)
|
||||||
*
|
*
|
||||||
* @author Charles7c
|
|
||||||
* @see BusinessException
|
* @see BusinessException
|
||||||
|
*
|
||||||
|
* @author Charles7c
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*/
|
*/
|
||||||
public class CheckUtils extends Validator {
|
public class CheckUtils extends Validator {
|
||||||
|
@@ -24,8 +24,9 @@ import java.util.function.BooleanSupplier;
|
|||||||
/**
|
/**
|
||||||
* 基本参数校验工具类(抛出 400 BadRequestException)
|
* 基本参数校验工具类(抛出 400 BadRequestException)
|
||||||
*
|
*
|
||||||
|
* @see top.continew.starter.core.exception.BadRequestException
|
||||||
|
*
|
||||||
* @author Charles7c
|
* @author Charles7c
|
||||||
* @see BadRequestException
|
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*/
|
*/
|
||||||
public class ValidationUtils extends Validator {
|
public class ValidationUtils extends Validator {
|
||||||
|
@@ -33,9 +33,10 @@ import java.util.concurrent.ConcurrentHashMap;
|
|||||||
/**
|
/**
|
||||||
* 复合枚举类型处理器(扩展 BaseEnum 支持)
|
* 复合枚举类型处理器(扩展 BaseEnum 支持)
|
||||||
*
|
*
|
||||||
|
* @see com.baomidou.mybatisplus.core.handlers.CompositeEnumTypeHandler
|
||||||
|
*
|
||||||
* @author miemie(<a href="https://gitee.com/baomidou/mybatis-plus">MyBatis Plus</a>)
|
* @author miemie(<a href="https://gitee.com/baomidou/mybatis-plus">MyBatis Plus</a>)
|
||||||
* @author Charles7c
|
* @author Charles7c
|
||||||
* @see com.baomidou.mybatisplus.core.handlers.CompositeEnumTypeHandler
|
|
||||||
* @since 2.7.3
|
* @since 2.7.3
|
||||||
*/
|
*/
|
||||||
public class CompositeBaseEnumTypeHandler<E extends Enum<E>> implements TypeHandler<E> {
|
public class CompositeBaseEnumTypeHandler<E extends Enum<E>> implements TypeHandler<E> {
|
||||||
|
@@ -45,9 +45,10 @@ import java.util.concurrent.ConcurrentHashMap;
|
|||||||
/**
|
/**
|
||||||
* 枚举类型处理器(扩展 BaseEnum 支持)
|
* 枚举类型处理器(扩展 BaseEnum 支持)
|
||||||
*
|
*
|
||||||
|
* @see com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler
|
||||||
|
*
|
||||||
* @author hubin(<a href="https://gitee.com/baomidou/mybatis-plus">MyBatis Plus</a>)
|
* @author hubin(<a href="https://gitee.com/baomidou/mybatis-plus">MyBatis Plus</a>)
|
||||||
* @author Charles7c
|
* @author Charles7c
|
||||||
* @see com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler
|
|
||||||
* @since 2.4.0
|
* @since 2.4.0
|
||||||
*/
|
*/
|
||||||
public class MybatisBaseEnumTypeHandler<E extends Enum<E>> extends BaseTypeHandler<E> {
|
public class MybatisBaseEnumTypeHandler<E extends Enum<E>> extends BaseTypeHandler<E> {
|
||||||
|
@@ -55,6 +55,7 @@ import java.util.function.Function;
|
|||||||
* <p>将 MP 的 {@link CrudRepository} 迁移至本类中,减少两层继承,解决层级过多出现 Sonar 警告的问题</p>
|
* <p>将 MP 的 {@link CrudRepository} 迁移至本类中,减少两层继承,解决层级过多出现 Sonar 警告的问题</p>
|
||||||
*
|
*
|
||||||
* @see CrudRepository
|
* @see CrudRepository
|
||||||
|
*
|
||||||
* @param <M> Mapper 接口
|
* @param <M> Mapper 接口
|
||||||
* @param <T> 实体类型
|
* @param <T> 实体类型
|
||||||
* @author hubin (<a href="https://gitee.com/baomidou/mybatis-plus">MyBatis Plus</a>)
|
* @author hubin (<a href="https://gitee.com/baomidou/mybatis-plus">MyBatis Plus</a>)
|
||||||
|
@@ -28,8 +28,9 @@ import top.continew.starter.core.enums.BaseEnum;
|
|||||||
/**
|
/**
|
||||||
* Easy Excel 枚举接口转换器
|
* Easy Excel 枚举接口转换器
|
||||||
*
|
*
|
||||||
* @author Charles7c
|
|
||||||
* @see BaseEnum
|
* @see BaseEnum
|
||||||
|
*
|
||||||
|
* @author Charles7c
|
||||||
* @since 1.2.0
|
* @since 1.2.0
|
||||||
*/
|
*/
|
||||||
public class ExcelBaseEnumConverter implements Converter<BaseEnum<?>> {
|
public class ExcelBaseEnumConverter implements Converter<BaseEnum<?>> {
|
||||||
|
@@ -29,6 +29,7 @@ import java.lang.annotation.*;
|
|||||||
*
|
*
|
||||||
* @see cn.hutool.core.lang.tree.TreeNodeConfig
|
* @see cn.hutool.core.lang.tree.TreeNodeConfig
|
||||||
* @see CrudTreeProperties
|
* @see CrudTreeProperties
|
||||||
|
*
|
||||||
* @author Charles7c
|
* @author Charles7c
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*/
|
*/
|
||||||
|
@@ -28,6 +28,7 @@ import top.continew.starter.extension.crud.annotation.TreeField;
|
|||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @see TreeField
|
* @see TreeField
|
||||||
|
*
|
||||||
* @author Charles7c
|
* @author Charles7c
|
||||||
* @since 2.7.2
|
* @since 2.7.2
|
||||||
*/
|
*/
|
||||||
|
@@ -32,8 +32,9 @@ import java.util.Objects;
|
|||||||
/**
|
/**
|
||||||
* 枚举接口 BaseEnum 反序列化器
|
* 枚举接口 BaseEnum 反序列化器
|
||||||
*
|
*
|
||||||
* @author Charles7c
|
|
||||||
* @see BaseEnum
|
* @see BaseEnum
|
||||||
|
*
|
||||||
|
* @author Charles7c
|
||||||
* @since 2.4.0
|
* @since 2.4.0
|
||||||
*/
|
*/
|
||||||
@JacksonStdImpl
|
@JacksonStdImpl
|
||||||
|
@@ -27,8 +27,9 @@ import java.io.IOException;
|
|||||||
/**
|
/**
|
||||||
* 枚举接口 BaseEnum 序列化器
|
* 枚举接口 BaseEnum 序列化器
|
||||||
*
|
*
|
||||||
* @author Charles7c
|
|
||||||
* @see BaseEnum
|
* @see BaseEnum
|
||||||
|
*
|
||||||
|
* @author Charles7c
|
||||||
* @since 2.4.0
|
* @since 2.4.0
|
||||||
*/
|
*/
|
||||||
@JacksonStdImpl
|
@JacksonStdImpl
|
||||||
|
@@ -23,9 +23,10 @@ package top.continew.starter.trace.autoconfigure;
|
|||||||
* 重写 TLog 配置以适配 Spring Boot 3.x
|
* 重写 TLog 配置以适配 Spring Boot 3.x
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
|
* @see com.yomahub.tlog.springboot.property.TLogProperty
|
||||||
|
*
|
||||||
* @author Bryan.Zhang
|
* @author Bryan.Zhang
|
||||||
* @author Jasmine
|
* @author Jasmine
|
||||||
* @see com.yomahub.tlog.springboot.property.TLogProperty
|
|
||||||
* @since 1.3.0
|
* @since 1.3.0
|
||||||
*/
|
*/
|
||||||
public class TLogProperties {
|
public class TLogProperties {
|
||||||
|
@@ -33,9 +33,10 @@ import java.io.IOException;
|
|||||||
* 重写 TLog 配置以适配 Spring Boot 3.x
|
* 重写 TLog 配置以适配 Spring Boot 3.x
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
|
* @see com.yomahub.tlog.web.filter.TLogServletFilter
|
||||||
|
*
|
||||||
* @author Bryan.Zhang
|
* @author Bryan.Zhang
|
||||||
* @author Jasmine
|
* @author Jasmine
|
||||||
* @see com.yomahub.tlog.web.filter.TLogServletFilter
|
|
||||||
* @since 1.3.0
|
* @since 1.3.0
|
||||||
*/
|
*/
|
||||||
public class TLogServletFilter implements Filter {
|
public class TLogServletFilter implements Filter {
|
||||||
|
@@ -28,9 +28,10 @@ import jakarta.servlet.http.HttpServletRequest;
|
|||||||
* 重写 TLog 配置以适配 Spring Boot 3.x
|
* 重写 TLog 配置以适配 Spring Boot 3.x
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
|
* @see com.yomahub.tlog.web.common.TLogWebCommon
|
||||||
|
*
|
||||||
* @author Bryan.Zhang
|
* @author Bryan.Zhang
|
||||||
* @author Jasmine
|
* @author Jasmine
|
||||||
* @see com.yomahub.tlog.web.common.TLogWebCommon
|
|
||||||
* @since 1.3.0
|
* @since 1.3.0
|
||||||
*/
|
*/
|
||||||
public class TLogWebCommon extends TLogRPCHandler {
|
public class TLogWebCommon extends TLogRPCHandler {
|
||||||
|
Reference in New Issue
Block a user