cn.mapway.document.annotation

注释类型 ApiField

@Documented
 @Retention(value=RUNTIME)
 @Target(value={FIELD,PARAMETER,METHOD})
public @interface ApiField

API 字段注解.

作者:

zhangjianshe@navinfo.com

必需元素概要

所需元素

限定符和类型	必需的元素和说明
String	value 描述.

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	example 给出一个字段值得例子.
int	length 长度.
boolean	mandidate 是否是强制类型.
int	order 字段的排序.

元素详细资料

value

public abstract String value

描述.

返回:

the string

length

public abstract int length

长度.

返回:

the int

默认值:

0

example

public abstract String example

给出一个字段值得例子.

返回:

the string

默认值:

""

mandidate

public abstract boolean mandidate

是否是强制类型.

返回:

true, if successful

默认值:

true

order

public abstract int order

字段的排序.

返回:

the int

默认值:

0