!130 optimize javadoc

Merge pull request !130 from 王帅/main

mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/Condition.java

@@ -28,17 +28,17 @@ import java.lang.annotation.*;
 public @interface Condition {
 
     /**
-     * 列名
+     * 列名。
      */
     String column();
 
     /**
-     * 逻辑值，> , >= , = ,  IS NULL, IS NOT NULL 等
+     * 逻辑值，> , >= , = ,  IS NULL, IS NOT NULL 等。
      */
     String logic() default " = ";
 
     /**
-     * 值
+     * 值。
      */
     String[] value() default {};
 

mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationManyToMany.java

@@ -35,14 +35,26 @@ public @interface RelationManyToMany {
     String selfField() default "";
 
     /**
-     * 目标实体类对应的表的 schema，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表的 schema 模式。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(schema = "...")} 指定 schema 时，
+     * 需要在这里指定对应表的 schema 值。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return schema 名称
      */
     String targetSchema() default "";
 
     /**
-     * 目标实体类对应的表，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表名。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(value = "...")} 指定表名时，
+     * 需要在这里指定对应表的表名。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return 表名
      */
@@ -77,7 +89,7 @@ public @interface RelationManyToMany {
     String joinTargetColumn();
 
     /**
-     * 查询时，追加的额外条件
+     * 查询时，追加的额外条件。
      */
     Condition[] extraConditions() default {};
 
@@ -95,5 +107,4 @@ public @interface RelationManyToMany {
      */
     String dataSource() default "";
 
-
 }

mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationManyToOne.java

@@ -35,14 +35,26 @@ public @interface RelationManyToOne {
     String selfField();
 
     /**
-     * 目标实体类对应的表的 schema，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表的 schema 模式。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(schema = "...")} 指定 schema 时，
+     * 需要在这里指定对应表的 schema 值。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return schema 名称
      */
     String targetSchema() default "";
 
     /**
-     * 目标实体类对应的表，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表名。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(value = "...")} 指定表名时，
+     * 需要在这里指定对应表的表名。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return 表名
      */

mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationOneToMany.java

@@ -35,14 +35,26 @@ public @interface RelationOneToMany {
     String selfField() default "";
 
     /**
-     * 目标实体类对应的表的 schema，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表的 schema 模式。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(schema = "...")} 指定 schema 时，
+     * 需要在这里指定对应表的 schema 值。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return schema 名称
      */
     String targetSchema() default "";
 
     /**
-     * 目标实体类对应的表，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表名。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(value = "...")} 指定表名时，
+     * 需要在这里指定对应表的表名。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return 表名
      */
@@ -77,7 +89,7 @@ public @interface RelationOneToMany {
     String joinTargetColumn() default "";
 
     /**
-     * 查询时，追加的额外条件
+     * 查询时，追加的额外条件。
      */
     Condition[] extraConditions() default {};
 

mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationOneToOne.java

@@ -35,14 +35,26 @@ public @interface RelationOneToOne {
     String selfField() default "";
 
     /**
-     * 目标实体类对应的表的 schema，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表的 schema 模式。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(schema = "...")} 指定 schema 时，
+     * 需要在这里指定对应表的 schema 值。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return schema 名称
      */
     String targetSchema() default "";
 
     /**
-     * 目标实体类对应的表，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表名。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(value = "...")} 指定表名时，
+     * 需要在这里指定对应表的表名。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return 表名
      */

mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/Table.java

@@ -22,6 +22,7 @@ import java.lang.annotation.Target;
 
 /**
  * 数据库表信息注解。
+ *
  * @author Michael Yang
  */
 @Retention(RetentionPolicy.RUNTIME)