org.nutz.plugins.apidoc.annotation

注释类型 ApiParam

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

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	dateFormat 日期格式
String	defaultValue 缺省值
String	description 描述
boolean	ignore 是否忽略
int	index 参数索引,用于匹配方法参数
String	name 参数名称
boolean	optional 是否可选
String	type 类型

元素详细资料

name

public abstract String name

参数名称

默认值:

""

description

public abstract String description

描述

默认值:

""

type

public abstract String type

类型

默认值:

""

defaultValue

public abstract String defaultValue

缺省值

默认值:

""

dateFormat

public abstract String dateFormat

日期格式

默认值:

""

optional

public abstract boolean optional

是否可选

默认值:

false

index

public abstract int index

参数索引,用于匹配方法参数

默认值:

-1

ignore

public abstract boolean ignore

是否忽略

默认值:

false