常用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 解释 标识对象过期 |
适用范围：文件、类、方法
|
|
