从工作开始，经历了几个项目的开发，现在的项目一般都是一个团队共同开发，而每个人都有自己的编码习惯，为了统一格式，项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置，但是在执行过程中往往发现效果不是很好（主要是指编码规范这一方面）。所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格。主要包括三个方面：设置Code Templates、Eclipse formatter、Checkstyle，本篇主要介绍如何设置Code Templates，具体步骤如下：

打开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文件注释）

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类注释）

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（类字段注释）

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

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

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

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

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（重写方法注释）

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

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

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

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

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

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

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

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

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（方法体模板）

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

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

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

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

Java代码  
  1. return ${field};

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

Java代码  
  1. ${field} = ${param};

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

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

其中codetemplates.xml内容如下：

Xml代码  
  1. <?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><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">/**
  2. * ${bare_field_name}.
  3. *
  4. * @return  the ${bare_field_name}
  5. * @since   JDK 1.6
  6. */</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">/**
  7. * ${param}.
  8. *
  9. * @param   ${param}    the ${bare_field_name} to set
  10. * @since   JDK 1.6
  11. */</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">/**
  12. * Creates a new instance of ${enclosing_type}.
  13. *
  14. * ${tags}
  15. */
  16. </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">/**
  17. * Project Name:${project_name}
  18. * File Name:${file_name}
  19. * Package Name:${package_name}
  20. * Date:${date}${time}
  21. * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved.
  22. *
  23. */</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">/**
  24. * ClassName: ${type_name} &lt;br/&gt;
  25. * Function: ${todo} ADD FUNCTION. &lt;br/&gt;
  26. * Reason: ${todo} ADD REASON(可选). &lt;br/&gt;
  27. * date: ${date} ${time} &lt;br/&gt;
  28. *
  29. * @author ${user}
  30. * @version ${enclosing_type}${tags}
  31. * @since JDK 1.6
  32. */</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">/**
  33. * ${field}:${todo}(用一句话描述这个变量表示什么).
  34. * @since JDK 1.6
  35. */</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">/**
  36. * ${enclosing_method}:(这里用一句话描述这个方法的作用). &lt;br/&gt;
  37. * ${todo}(这里描述这个方法适用条件 – 可选).&lt;br/&gt;
  38. * ${todo}(这里描述这个方法的执行流程 – 可选).&lt;br/&gt;
  39. * ${todo}(这里描述这个方法的使用方法 – 可选).&lt;br/&gt;
  40. * ${todo}(这里描述这个方法的注意事项 – 可选).&lt;br/&gt;
  41. *
  42. * @author ${user}
  43. * ${tags}
  44. * @since JDK 1.6
  45. */</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">/**
  46. * ${todo} 简单描述该方法的实现功能（可选）.
  47. * ${see_to_overridden}
  48. */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
  49. * ${tags}
  50. * ${see_to_target}
  51. */</template><template autoinsert="false" context="newtype_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype">/**
  52. * Project Name:${project_name}
  53. * File Name:${file_name}
  54. * Package Name:${package_name}
  55. * Date:${date}${time}
  56. * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved.
  57. *
  58. */
  59. ${filecomment}
  60. ${package_declaration}
  61. /**
  62. * ClassName:${type_name} &lt;br/&gt;
  63. * Function: ${todo} ADD FUNCTION. &lt;br/&gt;
  64. * Reason:   ${todo} ADD REASON. &lt;br/&gt;
  65. * Date:     ${date} ${time} &lt;br/&gt;
  66. * @author   ${user}
  67. * @version
  68. * @since    JDK 1.6
  69. * @see
  70. */
  71. ${typecomment}
  72. ${type_declaration}
  73. </template><template autoinsert="true" context="classbody_context" deleted="false" description="Code in new class type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.classbody" name="classbody">
  74. </template><template autoinsert="true" context="interfacebody_context" deleted="false" description="Code in new interface type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name="interfacebody">
  75. </template><template autoinsert="true" context="enumbody_context" deleted="false" description="Code in new enum type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.enumbody" name="enumbody">
  76. </template><template autoinsert="true" context="annotationbody_context" deleted="false" description="Code in new annotation type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name="annotationbody">
  77. </template><template autoinsert="true" context="catchblock_context" deleted="false" description="Code in new catch blocks" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.catchblock" name="catchblock">
  78. // ${todo} Auto-generated catch block
  79. ${exception_var}.printStackTrace();
  80. </template><template autoinsert="false" context="methodbody_context" deleted="false" description="Code in created method stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodbody" name="methodbody">
  81. // ${todo} Auto-generated method stub
  82. ${body_statement}</template><template autoinsert="true" context="constructorbody_context" deleted="false" description="Code in created constructor stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name="constructorbody">
  83. ${body_statement}
  84. // ${todo} Auto-generated constructor stub
  85. </template><template autoinsert="true" context="getterbody_context" deleted="false" description="Code in created getters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.getterbody" name="getterbody">return ${field};</template><template autoinsert="true" context="setterbody_context" deleted="false" description="Code in created setters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.setterbody" name="setterbody">${field} = ${param};</template></templates>

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

编码规范系列（一）：Eclipse Code Templates设置相关推荐

  1. Eclipse - Code Templates

    Eclipse - Code Templates Window -> Preferences -> C/C++ -> Code Style -> Code Templates ...

  2. 初始化HashMap的默认值——阿里巴巴编码规范系列

    阿里巴巴编码规范中,对HashMap的规定是:当HashMap初始化时,尽量指定初始值的大小. 原因:若不设置初始值,系统的默认初始容量为16,若超出这个阈值,就会触发自动扩容,HashMap的自动扩 ...

  3. iPhone开发入门守则：Objective-C编码规范--系列教程

    iPhone开发入门守则:Objective-C编码规范(1) iPhone开发入门守则:Objective-C编码规范(2) iPhone开发入门守则:Objective-C编码规范(3) iPho ...

  4. Eclipse中怎样设置字体大小和修改注释字体的颜色

    Eclipse中怎样设置字体大小 确认应用之后就可以看到编码的变大了 Eclipse中怎样设置修改注释字体的颜色 在eclispe中设置编辑区的背景颜色 Eclipse中工作区界面的调整

  5. Java语言编码规范(Java Code Conventions)

    1 介绍(Introduction) 1.1 为什么要有编码规范(Why Have Code Conventions) 编码规范对于程序员而言尤为重要,有以下几个原因: - 一个软件的生命周期中,80 ...

  6. eclipse注释模板设置（未整理）

    Window --> Java --> Code Style --> Code Templates --> Comments --> types --> Edit ...

  7. 《阿里巴巴编码规范（JAVA）》学习认证考后感

    image.png <阿里巴巴 Java 开发手册>是阿里巴巴集团技术团队的集体智慧结晶和经验总结,经历了多次大规模一线实战的检验及不断完善,系统化地整理成册,回馈给广大开发者. 本手册的 ...

  8. Discuz代码研究-编码规范

    来源:http://www.cnblogs.com/janas/archive/2013/08/20/3271408.html Discuz中的编码规范很值得PHP开发人员借鉴.里面既介绍了编码时代码 ...

  9. IDE-Ecplise-代码注释 模版 编码规范 配色

    说明: 代码注释主要用于方便代码后期维护,编码规范,增加代码阅读性和维护性.因网上看到的很多博客中片段局多,故整理后重写一篇,方便交流学习. 先看下加过注释模版后的效果. 如上图所示,创建类,方法和继 ...

最新文章

  1. 记一次大规模数据迁移和加密
  2. C++中的命名空间namespace
  3. Android安全加密：对称加密
  4. 寄存器、存储器、内存的区别
  5. [渝粤教育] 浙江工商大学 大学英语（4）（韩颖） 参考 资料
  6. 2021了，你还不能玩转js正则表达式？
  7. vue filters使用
  8. 对FreeMarker技术的思考
  9. 调用支付jsapi缺少参数package怎么解决_干货：如何借助小程序云开发实现小程序支付功能（含源码）...
  10. 序列号大全,装机必备
  11. 对于高级搜索部分的要求
  12. U盘安装Ubuntu操作系统
  13. 吴恩达—机器学习的六个核心算法
  14. linux卸载pm2,Linux服务器部署Nodejs项目，使用pm2管理
  15. linux下c 开发 腾讯视频播放器,调用腾讯视频播放器API代码
  16. SRAM与DRAM的区别
  17. 【Proteus仿真】TLC5615输出1024点正弦波（振幅可调）
  18. win7台式机解决插入耳机没有声音以及显示麦克风未插入的解决方法
  19. 光删除微信聊天记录是没用的！通过这招，才能完全清空！
  20. vc sp6补丁下载地址及具体安装

热门文章

  1. 全网最快安装JDK17教程（windows版本）
  2. HTTP请求方式中GET和POST的区别?
  3. 字符串校验器 ExcelValidator.java
  4. JSP如何获取Spring Boot的配置属性
  5. MyBatis3源码解析(5)查询结果处理
  6. 滚动图片广告_女排赢球可喜看台马桶广告扎眼 网友：去男足赛场！别在这儿蹭热点...
  7. ios怎么创建html文件夹,ios 创建html文件
  8. cx_oracle主备服务器,怎么在Python中使用cx_Oracle模块对Oracle数据库进行操作
  9. BootStrap中的日期时间组件datetimepicker
  10. 计算机系统概论实验报告3,东南大学计算机网络第四次实验报告.docx