在Eclipse中设置自动生成注释

在Eclipse中设置自动生成注释

Eclipse中Window-->Java-->Code Style-->Code Templates

Code-->New Java files，选择Edit，添加如下文本：

${filecomment}
${package_declaration}
/**
* @auther James Yang
* @date ${date} ${time}
* @version 1.0
* @parameter
* @throws 
* @since
* @return     
*/
${typecomment}
${type_declaration}

这样添加注释后，利用javadoc可以自动生成API文档。

关键词列表：

@author 作者名

@date 日期

@version 版本标识

@parameter 参数及其意义

@since 最早使用该方法/类/接口的JDK版本

@return 返回值

@throws 异常类及抛出条件

@deprecated 引起不推荐使用的警告

@see reference 查看引用

@override 重写

更多Javadoc用法可以访问：百度百科、官方文档。