cn.mapway.document.annotation

注释类型 Doc

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
public @interface Doc

自定义注解类，可以应用在类，方法，参数，字段上.

作者:

zhangjianshe @navinfo.com

必需元素概要

所需元素

限定符和类型	必需的元素和说明
String	value 描述信息,对要描述的类和方法做出解释和说明/title.

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	author 作者.
String	desc 描述信息.
String	group 接口分组信息 ,以 /为分隔符 进行树形分组，缺省归属为根节点.
int	order 接口在分组中的排序.
String[]	refs 引用的HTML文件.
DevelopmentState	state 开发状态.
ApiStyle	style API显示样式.
String[]	tags 接口的标签列表

元素详细资料

value

public abstract String value

描述信息,对要描述的类和方法做出解释和说明/title.

返回:

the string

desc

public abstract String desc

描述信息.

返回:

the string

默认值:

""

author

public abstract String author

作者.

返回:

the string

默认值:

"zhangjianshe@gmail.com"

group

public abstract String group

接口分组信息 ,以 /为分隔符 进行树形分组，缺省归属为根节点.

返回:

the string

默认值:

"/"

order

public abstract int order

接口在分组中的排序.

返回:

the int

默认值:

0

state

public abstract DevelopmentState state

开发状态.

返回:

the development state

默认值:

cn.mapway.document.annotation.DevelopmentState.UNSTART

style

public abstract ApiStyle style

API显示样式.

返回:

API显示样式. api style

默认值:

cn.mapway.document.annotation.ApiStyle.NORMAL

refs

public abstract String[] refs

引用的HTML文件.

返回:

引用的HTML文件. string [ ]

默认值:

{}

tags

public abstract String[] tags

接口的标签列表

返回:

接口的标签列表 string [ ]

默认值:

{}