下文笔者讲述在日常开发IDE工具中设置注释模板的方法分享，如下所示:
Eclipse中设置Java注释模板 Eclipse设置注释模板的菜单: Window->Preference->Java-> Code Style-> Code Template 然后展开Comments节点即可设置代码模板
Java注释模板标签语法
| 标签 | 作用域 | 说明 |
| @author | 类 | 标明开发该类模块作者 |
| @version | 类 | 标明该类模块的版本 |
| @see | 类, 属性, 方法 | 参考转向(相关主题) |
| @param | 方法 | 对方法中某参数的说明 |
| @return | 方法 | 对方法返回值的说明 |
| @exception | 方法 | 抛出的异常类型 |
| @throws | 方法 | 与@exception相同 |
| @deprecated | 方法 | 不建议使用该方法 |
注释模板例子
文件(Files)注释标签
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author A18ccms A18ccms_gmail_com
* @date ${date} ${time}
* @version V1.0
*/
类型(Types)注释标签（类的注释）
/**
* @ClassName: ${type_name}
* @Description: ${todo}
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
*
* ${tags}
*/
字段(Fields)注释标签
/**
* @Fields ${field} : ${todo}
*/
构造函数标签
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法(Constructor & Methods)标签
/**
* @Title: ${enclosing_method}
* @Description: ${todo}
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/
覆盖方法(Overriding Methods)标签
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法(Delegate Methods)标签
/**
* ${tags}
* ${see_to_target}
*/
getter方法标签
/**
* @return ${bare_field_name}
*/
setter方法标签
/**
* @param ${param} 要设置的 ${bare_field_name}
*/
版权声明
本文仅代表作者观点，不代表本站立场。
本文系作者授权发表，未经许可，不得转载。
