Eclipse注释模版

打开Window->Preferences->Java->Code Style->Code Templates

点击"Import"，导入模板codetemplates.xml文件。

codetemplates.xml内容是我们自己预先定义好的，在这里先不详细描述，我们可以看到Eclipse Code Templates界面中间Configure generated code and comments区域包含了两个菜单树：Comment、Code，如下图所示：

Comments代表注释模板，Code代表代码模板，其中每一个子菜单代表子项的模板。

我们只要点击某一个子项，就会在界面下方的Pattern区域看到该项我们所定义的模板内容和格式，如下图所示：

如上图所示，当我们点击Comments下的Files子菜单时，下面的Pattern会显示Java文件的头部注释。

下面详细列出每一个子项的模板格式：

Comments-->Files（Java文件注释）

1. /**
2. * Project Name:${project_name}
3. * File Name:${file_name}
4. * Package Name:${package_name}
5. * Date:${date}${time}
6. * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved.
7. *
8. */

Comments-->Types（Java类注释）

1. /**
2. * ClassName: ${type_name} <br/>
3. * Function: ${todo} ADD FUNCTION. <br/>
4. * Reason: ${todo} ADD REASON(可选). <br/>
5. * date: ${date} ${time} <br/>
6. *
7. * @author ${user}
8. * @version ${enclosing_type}${tags}
9. * @since JDK 1.6
10. */

Comments-->Fields（类字段注释）

1. /**
2. * ${field}:${todo}(用一句话描述这个变量表示什么).
3. * @since JDK 1.6
4. */

Comments-->Constructors（构造函数注释）

1. /**
2. * Creates a new instance of ${enclosing_type}.
3. *
4. * ${tags}
5. */

Comments-->Methods（Java方法注释）

1. /**
2. * ${enclosing_method}:(这里用一句话描述这个方法的作用). <br/>
3. * ${todo}(这里描述这个方法适用条件 – 可选).<br/>
4. * ${todo}(这里描述这个方法的执行流程 – 可选).<br/>
5. * ${todo}(这里描述这个方法的使用方法 – 可选).<br/>
6. * ${todo}(这里描述这个方法的注意事项 – 可选).<br/>
7. *
8. * @author ${user}
9. * ${tags}
10. * @since JDK 1.6
11. */

Comments-->Overriding methods（重写方法注释）

1. /**
2. * ${todo} 简单描述该方法的实现功能（可选）.
3. * ${see_to_overridden}
4. */

Comments-->Delegate methods（代理方法注释）

1. /**
2. * ${tags}
3. * ${see_to_target}
4. */

Comments-->Getters（Java Getter方法注释）

1. /**
2. * ${bare_field_name}.
3. *
4. * @return  the ${bare_field_name}
5. * @since   JDK 1.6
6. */

Comments-->Setters（Java Setters方法注释）

1. /**
2. * ${param}.
3. *
4. * @param   ${param}    the ${bare_field_name} to set
5. * @since   JDK 1.6
6. */

Code-->New Java files（新建java文件代码模板）

1. /**
2. * Project Name:${project_name}
3. * File Name:${file_name}
4. * Package Name:${package_name}
5. * Date:${date}${time}
6. * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved.
7. *
8. */
9. ${filecomment}
10. ${package_declaration}
11. /**
12. * ClassName:${type_name} <br/>
13. * Function: ${todo} ADD FUNCTION. <br/>
14. * Reason:   ${todo} ADD REASON. <br/>
15. * Date:     ${date} ${time} <br/>
16. * @author   ${user}
17. * @version
18. * @since    JDK 1.6
19. * @see
20. */
21. ${typecomment}
22. ${type_declaration}

Code-->Method body（方法体模板）

1. // ${todo} Auto-generated method stub
2. ${body_statement}

Code-->Constructor body（构造函数模板）

1. ${body_statement}
2. // ${todo} Auto-generated constructor stub

Code-->Getter body（字段Getter方法模板）

1. return ${field};

Code-->Setter body（字段Setter方法模板）

1. ${field} = ${param};

Code-->Catch block body（异常catch代码块模板）

1. // ${todo} Auto-generated catch block
2. ${exception_var}.printStackTrace();

其中codetemplates.xml内容如下：

　　

eclipse--windows-preference--java--Code style--code Templater   处导入

操作

1.复制以下xml代码保存到xml空文件中，保存后使用eclipse到code Templater 导入即可。

2.查看效果代码

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="false" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/** ${tags}

* ${see_to_target}

*/

</template><template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/** @Title: ${enclosing_method} <BR>

* @Description: <BR>

* @return: ${field_type} <BR>

*/

</template><template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** <p>Title: ${enclosing_method}</p>

* <p>Description: </p>

* ${tags}

* ${see_to_overridden}

*/

</template><template autoinsert="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/** @Title: ${enclosing_method}

* @Description:

* @param: ${tags}

* @return: ${return_type}

* @throws

* @author ${user}

* @Date ${date} ${time}

*/

</template><template autoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/** FileName: ${file_name}

* @Description:

* Company: 北京钻天猴科技有限公司

* @author: ${user}

* @version V2.0

* Createdate: ${date} ${time}

*/

</template><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/** @package: ${package_name}

* @Title: ${type_name}

* @Description:

* @Company: 北京钻天猴科技有限公司

* @author ${user}

* @date ${date} ${time}

*/</template><template autoinsert="false" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**

* @Fields ${field} :

*/</template><template autoinsert="false" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/** @Title: ${enclosing_type}

* @Description:

* @param: ${tags}

* @throws

*/

</template><template autoinsert="false" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/** @Title: ${enclosing_method} <BR>

* @Description: <BR>

* @return: ${field_type} <BR>

*/

</template></templates>

效果代码：

 

/**

* @package: cn.zuantianhou.manage.web.controller

1. * @Title: PageController
2. * @Description: 页面跳转控制类
3. * @Company: 北京钻天猴科技有限公司
4. * @author MrLu
5. * @date 2017年2月16日 上午10:41:24
6. */
7. @Controller
8. @RequestMapping("page")
9. public class PageController {
10. /**
11. * @Title: toPage
12. * @Description: 一级页面跳转
13. * @param: @param pageName
14. * @param: @param request
15. * @param: @return
16. * @return: String
17. * @throws
18. * @author MrLu
19. * @Date 2017年2月16日 上午10:41:37
20. */
21. @RequestMapping(value="{pageName}",method=RequestMethod.GET)
22. public String toPage(@PathVariable("pageName") String pageName,HttpServletRequest request){
23. if(pageName.equals("reCaptcha")){
24. return "reCaptcha";
25. }
26. Manager user = (Manager)request.getSession().getAttribute("user");
27. if(user!=null){
28. return pageName;
29. }else{
30. return "login";
31. }
32. }
33. }

设置Code Templates的目的主要是为了统一各种注释的格式以及代码的模板，只要设定好Code Templates之后利用Eclipse就可以方便地生成我们自定义的注释，开发人员也容易接受！