Java doc中@author、@version、@since、@param、@return、@throws、@deprecated代表什么意思以及怎么用?

2019年4月8日11:51:03 评论 5,788 741字阅读2分28秒

1.简介

Java doc中@author、@version、@since、@param、@return、@throws、@deprecated分别代表什么意思以及怎么用?——请看下文。

2.示例代码

/**
 * 版权所有 编程十万个怎么办(www.tah1986.com)
 */
public class Javadoc {
	/**
	 * 入口函数
	 *
	 * @param args 传入的参数列表
	 * @return No return value.
	 * @author 编程十万个怎么办(www.tah1986.com)
	 * @version 1.0
	 * @since 1.0
	 */
	public static void main(String[] args) {

	}

	/**
	 * @return 结果
	 * @deprecated 已废弃,请参考******
	 * @throws Exception 结果等于null时会抛异常
	 */
	private static String getResult() throws Exception {
		String result = null ;
		if (result == null) {
			throw new  Exception("result is null");
		}
		return "";
	}
}

3.总结

标签注释
@author作者说明
适用范围:文件、类、方法
(*多个作者使用多个@author标签标识,java
doc中显示按输入时间顺序罗列。)
@version版本号,用于标识注释对象的版本号
适用范围:文件、类、方法
@sinceJDK版本,用于标识编译该文件所需要的JDK环境。
适用范围:文件、类
@param参数的名称说明
适用范围:方法
@return输出参数说明
适用范围:方法
@throws异常,标识出方法可能抛出的异常
适用范围:方法
@deprecated解释,标识对象过期
适用范围:文件、类、方法