现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范。设置Code Templates的目的主要是为了统一各种注释的格式以及代码的模板,只要设定好Code Templates之后利用Eclipse就可以方便地生成我们自定义的注释,所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格。主要包括三个方面:设置Code Templates、Eclipse formatter,本篇主要介绍如何设置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文件注释)

  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();

编码规范:Eclipse Code Templates设置的更多相关文章

  1. (转)编码规范系列(一):Eclipse Code Templates设置

    背景:长久以来,对java编程中的注释不甚理解.再次学习<疯狂JAVA讲义>基础,深深的感到自己基本功的不牢固.所以要做到事无巨细,好好修炼. 认识注释 常识 注释的作用: 回顾原有的代码 ...

  2. 编码规范系列(一):Eclipse Code Templates设置

    从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范.俗话说约定优于配置,但是在执行过程中往往发现效 ...

  3. Eclipse Code Templates设置

    从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范.俗话说约定优于配置,但是在执行过程中往往发现效 ...

  4. eclipse code templates 设置(eclipse注释模版配置)

    文件(Files)注释标签:/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * Copyri ...

  5. Eclipse编码规范——Code Templates设置

    Eclipse编码规范——Code Templates设置 Eclipse编码规范主要包括三个方面:设置Code Templates.Eclipse formatter.Checkstyle, 本篇主 ...

  6. Eclipse Code Template 设置自动加注释(转)

    Eclipse Code Template 设置自动加注释 设置注释模板的入口: Window->Preference->Java->Code Style->Code Temp ...

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

    Java语言编码规范(Java Code Conventions) 名称 Java语言编码规范(Java Code Conventions) 译者 晨光(Morning) 简介 本文档讲述了Java语 ...

  8. 关于eclipse的编码注释等Code Template设置

    啥也不说直接放东西: 首先进入eclipse的preferences里的java 点击Insert variable可以自己设置需要的 1. 设置Files:点击edit, /** * <p&g ...

  9. 编码规范(code style guide)

    1. Javascript Google: https://google.github.io/styleguide/jsguide.html Airbnb:https://github.com/air ...

随机推荐

  1. scala 学习笔记六 推导

    1.介绍 在Scala中,推导将生成器.过滤器.和定义组合在一起. 2.例子 有一种将result用作val(而不是var)的方式,:“就地”构建result,而不是逐项构建,利用yield关键字,当 ...

  2. ElasticSearch关闭重启命令

    很多人学习elasticSearch都是自学,想百度一下如何重启es也是没有答案,我硬着头皮,算是琢磨出来了,借此写博,希望能帮助您. 1.如何关闭ES,elasticsearch关闭办法 1.使用h ...

  3. php实现支付宝授权登录

    第一步: 登录到蚂蚁金服开放平台https://open.alipay.com/platform/home.htm,前提是有商户号.创建应用之后,然后到开发者中心开通对应功能.如图: 第二步: 到应用 ...

  4. [Javascipt] Immediately-Invoker 2

    Now the people at Poplar Puzzles would like you to treat an array of functions like a Queue, passing ...

  5. Coredata — 入门使用

    CoreData的底层实现尽管是使用的sqlite数据库.但是CoreData在使用起来但是和sqlite大相径庭.可能你会发现你连一句sql语句都不要写.CoreData存在于应用程序和持久化存储区 ...

  6. 微信公众号开发之如何使用JSSDK

    微信开发交流群:148540125 欢迎留言.转发.打赏 系列文章参考地址 极速开发微信公众号 项目源码参考地址 点我点我--欢迎Start 查看公众号是否有使用JSSDK的权限 服务号.订阅号可以通 ...

  7. Asp.net 之页面处理积累(一)

    1.实现超链接跳转网页直接定位到跳转后页面中部,而不是要往下拖,才能看到想看的内容 (1)在跳转后页面想定位的位置加:<a name="middle" id="mi ...

  8. CATransition 动画处理视图切换

    一:引入包和头文件:   需要在frameworks中添加QuartzCore.framework 在接口程序中加上头文件   #import <QuartzCore/QuartzCore.h& ...

  9. PHP高级教程-过滤器

    PHP 过滤器 PHP 过滤器用于验证和过滤来自非安全来源的数据,比如用户的输入. 什么是 PHP 过滤器? PHP 过滤器用于验证和过滤来自非安全来源的数据. 测试.验证和过滤用户输入或自定义数据是 ...

  10. 一些面试基本知识(Android篇一)

    Android Activity设计模式之MVC模式(介绍MVP之前的引子) 參考博客.文章 http://www.cnblogs.com/liqw/p/4175325.html MVC即Model- ...