设置java注释模板

合集下载
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments 节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:

文件(Files)注释标签:

/**

* @Project: ${project_name}

* @Title: ${file_name}

* @Package ${package_name}

* @Description: ${todo}

* @author shenyanghong ahong2011@

* @date ${date} ${time}

* @Copyright: ${year} Inc. All rights reserved.

* @version V1.0

*/

类(Types)注释标签(类的注释):

/**

* @ClassName ${type_name}

* @Description ${todo}

* @author shenyanghong ahong2011@

* @date ${date}

* ${tags}

*/

字段(Fields)注释标签:

/**

* @Fields ${field} : ${todo}

*/

构造函数标签:

/**

*

Title:

*

Description:

* ${tags}

*/

方法(Constructor & Methods)标签:

/**

* @Title: ${enclosing_method}

* @Description: ${todo}

* @param ${tags} 设定文件

* @return ${return_type} 返回类型* @throws

*/

覆盖方法(Overriding Methods)标签:

/* (非 Javadoc)

*

Title: ${enclosing_method}

*

Description:

* ${tags}

* ${see_to_overridden}

*/

代表方法(Delegate Methods)标签:

/**

* ${tags}

* ${see_to_target}

*/

getter方法标签:

/**

* @return ${bare_field_name}

*/

setter方法标签:

/**

* @param ${param} 要设置的 ${bare_field_name}

*/

简单模板例1: