编码规范系列(一):Eclipse Code Templates设置
从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置,但是在执行过程中往往发现效果不是很好(主要是指编码规范这一方面)。所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格。主要包括三个方面:设置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文件注释)
- /**
- * Project Name:${project_name}
- * File Name:${file_name}
- * Package Name:${package_name}
- * Date:${date}${time}
- * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved.
- *
- */
Comments-->Types(Java类注释)
- /**
- * ClassName: ${type_name} <br/>
- * Function: ${todo} ADD FUNCTION. <br/>
- * Reason: ${todo} ADD REASON(可选). <br/>
- * date: ${date} ${time} <br/>
- *
- * @author ${user}
- * @version ${enclosing_type}${tags}
- * @since JDK 1.6
- */
Comments-->Fields(类字段注释)
- /**
- * ${field}:${todo}(用一句话描述这个变量表示什么).
- * @since JDK 1.6
- */
Comments-->Constructors(构造函数注释)
- /**
- * Creates a new instance of ${enclosing_type}.
- *
- * ${tags}
- */
Comments-->Methods(Java方法注释)
- /**
- * ${enclosing_method}:(这里用一句话描述这个方法的作用). <br/>
- * ${todo}(这里描述这个方法适用条件 – 可选).<br/>
- * ${todo}(这里描述这个方法的执行流程 – 可选).<br/>
- * ${todo}(这里描述这个方法的使用方法 – 可选).<br/>
- * ${todo}(这里描述这个方法的注意事项 – 可选).<br/>
- *
- * @author ${user}
- * ${tags}
- * @since JDK 1.6
- */
Comments-->Overriding methods(重写方法注释)
- /**
- * ${todo} 简单描述该方法的实现功能(可选).
- * ${see_to_overridden}
- */
Comments-->Delegate methods(代理方法注释)
- /**
- * ${tags}
- * ${see_to_target}
- */
Comments-->Getters(Java Getter方法注释)
- /**
- * ${bare_field_name}.
- *
- * @return the ${bare_field_name}
- * @since JDK 1.6
- */
Comments-->Setters(Java Setters方法注释)
- /**
- * ${param}.
- *
- * @param ${param} the ${bare_field_name} to set
- * @since JDK 1.6
- */
Code-->New Java files(新建java文件代码模板)
- /**
- * Project Name:${project_name}
- * File Name:${file_name}
- * Package Name:${package_name}
- * Date:${date}${time}
- * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved.
- *
- */
- ${filecomment}
- ${package_declaration}
- /**
- * ClassName:${type_name} <br/>
- * Function: ${todo} ADD FUNCTION. <br/>
- * Reason: ${todo} ADD REASON. <br/>
- * Date: ${date} ${time} <br/>
- * @author ${user}
- * @version
- * @since JDK 1.6
- * @see
- */
- ${typecomment}
- ${type_declaration}
Code-->Method body(方法体模板)
- // ${todo} Auto-generated method stub
- ${body_statement}
Code-->Constructor body(构造函数模板)
- ${body_statement}
- // ${todo} Auto-generated constructor stub
Code-->Getter body(字段Getter方法模板)
- return ${field};
Code-->Setter body(字段Setter方法模板)
- ${field} = ${param};
Code-->Catch block body(异常catch代码块模板)
- // ${todo} Auto-generated catch block
- ${exception_var}.printStackTrace();
其中codetemplates.xml内容如下:
- <?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">/**
- * ${bare_field_name}.
- *
- * @return the ${bare_field_name}
- * @since JDK 1.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">/**
- * ${param}.
- *
- * @param ${param} the ${bare_field_name} to set
- * @since JDK 1.6
- */</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">/**
- * Creates a new instance of ${enclosing_type}.
- *
- * ${tags}
- */
- </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">/**
- * Project Name:${project_name}
- * File Name:${file_name}
- * Package Name:${package_name}
- * Date:${date}${time}
- * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved.
- *
- */</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">/**
- * ClassName: ${type_name} <br/>
- * Function: ${todo} ADD FUNCTION. <br/>
- * Reason: ${todo} ADD REASON(可选). <br/>
- * date: ${date} ${time} <br/>
- *
- * @author ${user}
- * @version ${enclosing_type}${tags}
- * @since JDK 1.6
- */</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">/**
- * ${field}:${todo}(用一句话描述这个变量表示什么).
- * @since JDK 1.6
- */</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">/**
- * ${enclosing_method}:(这里用一句话描述这个方法的作用). <br/>
- * ${todo}(这里描述这个方法适用条件 – 可选).<br/>
- * ${todo}(这里描述这个方法的执行流程 – 可选).<br/>
- * ${todo}(这里描述这个方法的使用方法 – 可选).<br/>
- * ${todo}(这里描述这个方法的注意事项 – 可选).<br/>
- *
- * @author ${user}
- * ${tags}
- * @since JDK 1.6
- */</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">/**
- * ${todo} 简单描述该方法的实现功能(可选).
- * ${see_to_overridden}
- */</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">/**
- * ${tags}
- * ${see_to_target}
- */</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">/**
- * Project Name:${project_name}
- * File Name:${file_name}
- * Package Name:${package_name}
- * Date:${date}${time}
- * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved.
- *
- */
- ${filecomment}
- ${package_declaration}
- /**
- * ClassName:${type_name} <br/>
- * Function: ${todo} ADD FUNCTION. <br/>
- * Reason: ${todo} ADD REASON. <br/>
- * Date: ${date} ${time} <br/>
- * @author ${user}
- * @version
- * @since JDK 1.6
- * @see
- */
- ${typecomment}
- ${type_declaration}
- </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">
- </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">
- </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">
- </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">
- </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">
- // ${todo} Auto-generated catch block
- ${exception_var}.printStackTrace();
- </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">
- // ${todo} Auto-generated method stub
- ${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">
- ${body_statement}
- // ${todo} Auto-generated constructor stub
- </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设置的更多相关文章
- (转)编码规范系列(一):Eclipse Code Templates设置
背景:长久以来,对java编程中的注释不甚理解.再次学习<疯狂JAVA讲义>基础,深深的感到自己基本功的不牢固.所以要做到事无巨细,好好修炼. 认识注释 常识 注释的作用: 回顾原有的代码 ...
- 编码规范:Eclipse Code Templates设置
现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范.设置Code Templates的目的主要是为了统一各种注释的格式以及代码的模板 ...
- Eclipse Code Templates设置
从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范.俗话说约定优于配置,但是在执行过程中往往发现效 ...
- eclipse code templates 设置(eclipse注释模版配置)
文件(Files)注释标签:/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * Copyri ...
- 编码规范系列(二):Eclipse Checkstyle配置
http://chenzhou123520.iteye.com/blog/1627618 上一篇介绍了<编码规范系列(一):Eclipse Code Templates设置>,这篇主要介绍 ...
- Eclipse编码规范——Code Templates设置
Eclipse编码规范——Code Templates设置 Eclipse编码规范主要包括三个方面:设置Code Templates.Eclipse formatter.Checkstyle, 本篇主 ...
- Eclipse Code Template 设置自动加注释(转)
Eclipse Code Template 设置自动加注释 设置注释模板的入口: Window->Preference->Java->Code Style->Code Temp ...
- 编码规范(一)之Code Templates的设置(转)
编码规范(一)之Code Templates的设置 基于公司的主流开发工具为eclipse,但每个人都有自己的编码习惯,为了统一格式,这里通过三个方面:设置Code Templates.Checkst ...
- 编码规范(二)之Code Templates的设置(转)
http://swiftlet.net/archives/1199 编码规范(二)之Code Templates的设置(转) 文件(Files)注释标签:/** * @Title: ${file_na ...
随机推荐
- Android 仿百度网页音乐播放器圆形图片转圈播放效果
百度网页音乐播放器的效果 如下 : http://www.baidu.com/baidu?word=%E4%B8%80%E7%9B%B4%E5%BE%88%E5%AE%89%E9%9D%99& ...
- Oracle 课程六之hint
课程目标 完成本课程的学习后,您应该能够: •什么是oracle hint •Hint的使用范围 •Hint 汇总 •演示常用的hint Hint简介 Hint是oracle 提供的一种SQL语法 ...
- SQLlite(WebSQL)如何排序并分页查询(SQLlite语法)
SELECT * FROM Table ORDER BY ID DESC Limit 10,9 limit语义:跳过10行,取9行 参考: SQLite的limit用法 如果我要去11-20的Ac ...
- spring3.0.5的aop使用
spring3.0.5开始支持jpa2.0了,但是最近笔者在使用他的的时候发现了3.0.5的包与2.5.5相比,有所精简.其他外部的包,我们需要自己下载. AOP必须的spring包 org.spri ...
- hisi平台mii网络模式和rmii网络模式的uboot制作
MII网络uboot编译说明 一:编译生成默认的uboot1. 进入到uboot目录a. cd /home/satan/Hi3518_SDK_V1.0.7.0/osdrv/uboot2. 新建临时文件 ...
- 关于KOBE 退役
今天在网上看到一行话,写在KOBE 退役之际 关于职业,最值得问的是自己我有没有像科比那样始终表现出对团队的忠诚和对职业的热爱?从不被别人的误解和攻击打倒?在团队最困难的时候站出来做能做的一切?用职业 ...
- ylbtech-Model-Account(通用账户模块设计)
ylbtech-DatabaseDesgin:ylbtech-Model-Account(通用账户模块设计) ylbtech-Model-Account(通用账户模块设计) 1.A,数据库关系图(Da ...
- storm入门教程 第一章 前言[转]
1.1 实时流计算 互联网从诞生的第一时间起,对世界的最大的改变就是让信息能够实时交互,从而大大加速了各个环节的效率.正因为大家对信息实时响应.实时交互的需求,软件行业除了个人操作系统之外,数据库 ...
- Delphi RICHEDIT中插入图象
unit InsRich;interfaceuses Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms ...
- 警惕javascript代码中的“</script>”!
之前在写<博客园自定义博客侧边栏公告的过滤漏洞>的时候遇到了一个javascript代码报错“语法错误”的问题,一直不得以解决,感谢Arliang发现了并为我进行了耐心的解释,现整理如下: ...