style: 优化部分注释

continew-admin-common/src/main/java/top/charles7c/continew/admin/common/config/easyexcel/ExcelBaseEnumConverter.java

@@ -30,8 +30,9 @@
 import top.charles7c.continew.starter.data.mybatis.plus.enums.IBaseEnum;
 
 /**
- * Easy Excel 枚举基类转换器
+ * Easy Excel 枚举接口转换器
  *
+ * @see IBaseEnum
  * @author Charles7c
  * @since 2023/2/5 19:29
  */

continew-admin-common/src/main/java/top/charles7c/continew/admin/common/config/jackson/BaseEnumDeserializer.java

@@ -30,8 +30,9 @@
 import top.charles7c.continew.starter.data.mybatis.plus.enums.IBaseEnum;
 
 /**
- * 通用枚举基类 BaseEnum 反序列化器
+ * 通用枚举接口 IBaseEnum 反序列化器
  *
+ * @see IBaseEnum
  * @author Charles7c
  * @since 2023/1/8 13:56
  */

continew-admin-common/src/main/java/top/charles7c/continew/admin/common/config/jackson/BaseEnumSerializer.java

@@ -26,8 +26,9 @@
 import top.charles7c.continew.starter.data.mybatis.plus.enums.IBaseEnum;
 
 /**
- * 通用枚举接口 BaseEnum 序列化器
+ * 通用枚举接口 IBaseEnum 序列化器
  *
+ * @see IBaseEnum
  * @author Charles7c
  * @since 2023/1/8 13:56
  */

continew-admin-common/src/main/java/top/charles7c/continew/admin/common/config/jackson/JacksonConfiguration.java

@@ -30,6 +30,7 @@
 /**
  * Jackson 配置
  *
+ * @see IBaseEnum
  * @author Charles7c
  * @since 2022/12/11 13:23
  */
@@ -38,7 +39,7 @@
 public class JacksonConfiguration {
 
     /**
-     * 针对枚举基类 BaseEnum 的序列化和反序列化
+     * 针对枚举接口 IBaseEnum 的序列化和反序列化
      */
     @Bean
     public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder) {

continew-admin-common/src/main/java/top/charles7c/continew/admin/common/config/jackson/SimpleDeserializersWrapper.java

@@ -38,7 +38,7 @@
  * 重写增强后：<br>
  * 1. 同默认 1；<br>
  * 2. 同默认 2；<br>
- * 3. 如果也找不到 Enum 类型（所有枚举父类）的反序列化器，开始查找指定枚举类型的接口的反序列化器（例如：GenderEnum 枚举类型，则是找它的接口 BaseEnum 的反序列化器）；<br>
+ * 3. 如果也找不到 Enum 类型（所有枚举父类）的反序列化器，开始查找指定枚举类型的接口的反序列化器（例如：GenderEnum 枚举类型，则是找它的接口 IBaseEnum 的反序列化器）；<br>
  * 4. 同默认 3。
  * </p>
  *

continew-admin-common/src/main/java/top/charles7c/continew/admin/common/config/mybatis/MyBatisPlusMetaObjectHandler.java

@@ -113,7 +113,7 @@ public void updateFill(MetaObject metaObject) {
      * @param fillFieldValue
      *            要填充的字段值
      * @param isOverride
-     *            如果字段值不为空，是否覆盖（true 覆盖、false 不覆盖）
+     *            如果字段值不为空，是否覆盖（true：覆盖；false：不覆盖）
      */
     private void fillFieldValue(MetaObject metaObject, String fieldName, Object fillFieldValue, boolean isOverride) {
         if (metaObject.hasSetter(fieldName)) {

continew-admin-webapi/src/main/resources/config/application-dev.yml

@@ -17,7 +17,7 @@ spring.datasource:
     p6spy: true
     # 设置默认的数据源或者数据源组（默认 master）
     primary: master
-    # 严格匹配数据源（true 未匹配到指定数据源时抛异常；false 使用默认数据源；默认 false）
+    # 严格匹配数据源（true：未匹配到指定数据源时抛异常；false：使用默认数据源；默认 false）
     strict: false
     datasource:
       # 主库配置（可配多个，构成多主）

continew-admin-webapi/src/main/resources/config/application-prod.yml

@@ -19,7 +19,7 @@ spring.datasource:
     p6spy: false
     # 设置默认的数据源或者数据源组（默认 master）
     primary: master
-    # 严格匹配数据源（true 未匹配到指定数据源时抛异常；false 使用默认数据源；默认 false）
+    # 严格匹配数据源（true：未匹配到指定数据源时抛异常；false：使用默认数据源；默认 false）
     strict: false
     datasource:
       # 主库配置（可配多个，构成多主）

continew-admin-webapi/src/main/resources/config/application.yml

@@ -42,7 +42,7 @@ continew-starter.log:
 
 --- ### 接口文档配置
 springdoc:
-  # 设置对象型参数的展示形式（设为 true 表示将对象型参数平展开，即对象内的属性直接作为参数展示而不是嵌套在对象内，默认为 false）
+  # 设置对象型参数的展示形式（设为 true 表示将对象型参数平展开，即对象内的属性直接作为参数展示而不是嵌套在对象内，默认 false）
   # 如果不添加该全局配置，可以在需要如此处理的对象参数类上使用 @ParameterObject
   default-flat-param-object: true
   # 分组配置
@@ -87,9 +87,9 @@ springdoc:
 knife4j:
   enable: true
   setting:
-    # 是否显示默认的 footer（默认 true 显示）
+    # 是否显示默认的 footer（默认 true，显示）
     enable-footer: false
-    # 是否自定义 footer（默认 false 非自定义）
+    # 是否自定义 footer（默认 false，非自定义）
     enable-footer-custom: true
     # 自定义 footer 内容，支持 Markdown 语法
     footer-custom-content: 'Copyright © 2022-present [${project.contact.name}](${project.contact.url}) ⋅ [${project.name}](${project.url}) v${project.version}'
@@ -133,7 +133,7 @@ mybatis-plus:
   global-config:
     banner: true
     db-config:
-      # 主键类型（默认 assign_id 表示自行赋值）
+      # 主键类型（默认 assign_id，表示自行赋值）
       # auto 代表使用数据库自增策略（需要在表中设置好自增约束）
       id-type: AUTO
       # 逻辑删除字段
@@ -161,7 +161,7 @@ server:
     context-path: /
   ## Undertow 服务器配置
   undertow:
-    # HTTP POST 请求内容的大小上限（默认 -1 不限制）
+    # HTTP POST 请求内容的大小上限（默认 -1，不限制）
     max-http-post-size: -1
     # 以下的配置会影响 buffer，这些 buffer 会用于服务器连接的 IO 操作，有点类似 Netty 的池化内存管理
     # 每块 buffer的空间大小（越小的空间被利用越充分，不要设置太大，以免影响其他应用，合适即可）

continew-admin-webapi/src/main/resources/logback-spring.xml

@@ -3,7 +3,7 @@
 <!-- scan：当此属性设置为 true 时，配置文档如果发生改变，将会被重新加载，默认值为 true -->
 <!-- scanPeriod：设置监测配置文档是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。
        当 scan 为 true 时，此属性生效。默认的时间间隔为 1 分钟。 -->
-<!-- debug：当此属性设置为 true 时，将打印出 logback 内部日志信息，实时查看 logback 运行状态。默认值为 false。 -->
+<!-- debug：当此属性设置为 true 时，将打印出 logback 内部日志信息，实时查看 logback 运行状态。默认 false。 -->
 <configuration debug="false" scan="true" scanPeriod="30 seconds">
 
     <!-- 关闭 Logback 的状态监听器（通过更换默认状态监听器实现） -->