常用Java注释标签(Java comment tags)

常用Java注释标签(Java comment tags)

@author  作者

适用范围:文件、类、方法

(*多个作者使用多个@author标签标识,java doc中显示按输入时间顺序罗列。)

例:* @author Leo. Yao

@param  输入参数的名称说明

适用范围:方法

 

例:* @param str

the String用来存放输出信息。

@return 输出参数说明

适用范围:方法

* @return  0执行成功; 1执行失败.

@since

JDK版本,用于标识编译该文件所需要的JDK环境。

适用范围:文件、类

例:     * @since  JDK1.6

 

@version 版本号,用于标识注释对象的版本号

适用范围:文件、类、方法

 

* @version 1.0

@throws 异常,标识出方法可能抛出的异常

适用范围:方法

 

 * @throws IOException  If an input or output

exception occurred

 

@deprecated 解释

标识对象过期

适用范围:文件、类、方法

 

 

转载于:https://www.cnblogs.com/baoxiaofei/p/4162545.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值