docs: 优化annotation下所有注解的注释

This commit is contained in:
code2tan 2024-05-30 10:29:07 +08:00
parent a65532c71c
commit 1d95b66053
4 changed files with 65 additions and 12 deletions

View File

@ -4,6 +4,7 @@ import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author xgc
**/
@ -11,5 +12,6 @@ import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
public @interface ExtraParam {
String key();
String value();
}

View File

@ -4,11 +4,15 @@ import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author xgc
**/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MilvusCollection {
String name(); // 集合的名称
/**
* 集合的名称
*/
String name();
}

View File

@ -6,6 +6,7 @@ import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author xgc
**/
@ -13,14 +14,57 @@ import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
public @interface MilvusField {
String name() default ""; // 字段名称默认使用 Java 字段名
DataType dataType() default DataType.FloatVector; // 数据类型默认为 FLOAT_VECTOR
int dimension() default -1; // 向量维度仅对向量类型有效
boolean isPrimaryKey() default false; // 是否为主键
boolean autoID() default false; // 是否自动生成
String description() default ""; // 字段描述
DataType elementType() default DataType.None; // 数组或集合中元素的类型默认为 INVALID
int maxLength() default -1; // 数组或字符串类型的最大长度默认为 -1不指定
int maxCapacity() default -1; // 集合类型的最大容量默认为 -1不指定
boolean isPartitionKey() default false; // 是否为分区键
/**
* 字段名称默认使用 Java 字段名
*/
String name() default "";
/**
* 数据类型默认为 FLOAT_VECTOR
*
* @see DataType
*/
DataType dataType() default DataType.FloatVector;
/**
* 向量维度仅对向量类型有效
*/
int dimension() default -1;
/**
* 是否为主键
*/
boolean isPrimaryKey() default false;
/**
* 是否自动生成
*/
boolean autoID() default false;
/**
* 字段描述
*/
String description() default "";
/**
* 数组或集合中元素的类型默认为 INVALID
*
* @see DataType
*/
DataType elementType() default DataType.None;
/**
* 数组或字符串类型的最大长度
*/
int maxLength() default -1;
/**
* 集合类型的最大容量
*/
int maxCapacity() default -1;
/**
* 是否为分区键
*/
boolean isPartitionKey() default false;
}

View File

@ -11,5 +11,8 @@ import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MilvusPartition {
String[] name(); // 分区的名称
/**
* 分区的名称
*/
String[] name();
}