Java文档注释
修改过程:Window->Preferences->Java->Code Style->Code Templates->Comments->Types->Edit
注释解释:
This is a description text 类描述
@param K text 参数
@author sen 作者
@version 1.7,2014-06-19 版本号 ,日期
@see net.itaem.vo.Test2 索引到net.itaem.vo.Test2类(如在相同包则直接写Test2即可)
@since version 1.7 特性是从哪个版本设置的。
@deprecated text 废弃 废弃原因或推荐类
@return text 返回值解析
@throws exceptionName 异常类名
1)包
格式:(1)在对应的包中--提供一个package.html命名的HTML文件。在标记<body>...</body>之间的所有文本中写注释
(2)在对应的包中--提供一个package-info.java的Java文件。这个文件必须包含一个初始的以/**和*/接到你给的Javadoc注释,跟随在一个包语句之后。
2)公有类与接口
格式:
/**
* This is a description text 类描述* @param K text 参数* @author sen 作者* @version 1.7,2014-06-19 版本号 ,日期* @see Test2 索引到Test2类* @since version 1.7 特性是从哪个版本设置的。*/
3)公有的和受保护的方法
格式:
/**
* This is a description text 方法描述* @return text 返回值解释* @throws exceptionName 异常类名*/
4)公有的和受保护的域
格式:
/**
* This is a description text 域描述
*/
5)所有源文件
格式:在源文件目录src中--提供一个overview.html命名的HTML文件。在标记<body>...</body>之间的所有文本中写注释