- 浏览: 4247977 次
- 性别:
- 来自: 北京
文章分类
最新评论
-
masuweng:
...
kaptcha验证码组件使用简介 -
caobingyi:
你好,问下html是怎么调用loginCheck方法的?
kaptcha验证码组件使用简介 -
hayoouch:
XieFuQ 写道既然都考虑到乐观锁了,是否可以直接换表存储引 ...
mysql乐观锁总结和实践 -
murdonson:
辛苦了
mysql悲观锁总结和实践 -
iamnotstar:
写得不错,感谢分享
memcached-session-manager配置
从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置,但是在执行过程中往往发现效果不是很好(主要是指编码规范这一方面)。所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格。主要包括三个方面:设置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就可以方便地生成我们自定义的注释,开发人员也容易接受!
- codetemplates.zip (1.4 KB)
- 下载次数: 4308
发表评论
-
Win7 64位系统上配置使用32位的Eclipse
2014-04-10 17:47 22121最近工作电脑换成了64位的win7系统,之前个人电脑上安装的 ... -
Eclipse中输入系统变量和运行参数
2013-08-27 16:37 56441在开发时,有时候可能需要根据不同的环境设置不同的系统参数,我 ... -
Eclipse报错:java.lang.ClassNotFoundException: ContextLoaderListener
2013-03-26 22:32 136064Eclipse中tomcat部署工程启动后报错: 严重: ... -
Eclipse报错:Setting property 'source' to 'org.eclipse.jst.jee.server:test1' did no
2013-03-26 20:48 78180最近把Eclipse的maven插件从m2eclipse更新 ... -
Eclipse报错:Referenced classpath provider does not exist: org.maven.ide.eclipse……
2013-03-18 15:51 15811前段时间更新了Eclipse的maven插件,原来安装的是 ... -
Tomcat报错:Document base ……does not exist or is not a readable directory
2013-03-12 13:05 607422013年3月12: 用Eclipse ... -
Eclipse中Maven工程缺少Maven Dependencies
2013-02-21 19:43 203260Eclipse在引入Maven工程后,找不到Ma ... -
编码规范系列(二):Eclipse Checkstyle配置
2012-08-09 22:08 24670上一篇介绍了《编码规范系列(一):Eclipse Code T ... -
Eclipse常见错误以及解决方案
2012-08-03 18:15 36624错误一 :The type java.lang.Obje ... -
Maven依赖管理
2012-07-08 23:35 4841Maven提供dependencyManagemen ... -
Maven聚合与继承
2012-07-08 23:22 36668Maven聚合与继承 一、聚合 为了能够使用 ... -
使用Maven在Eclipse中创建Web项目
2012-07-08 23:16 15237一、新建 Maven Web项目 1.新建Mav ... -
Tomcat:"There are no resources that can be added or removed from the server"解决方案
2012-03-09 14:07 10896问题描述 把project从SVN上Checkout, ... -
使用statsvn统计svn中的代码量
2012-03-02 20:06 34635StatSVN介绍 StatSVN是一 ... -
敏捷开发中编写高质量Java代码
2012-02-02 12:04 2791本文转载自《敏捷开发中编写高质量Java代码》感谢作者的分享, ... -
在Eclipse或MyEclipse中安装findbugs插件
2011-12-16 10:11 24830我们都知道,在Eclipse或MyEclipse中安装插 ... -
在Eclipse中添加openjdk中源码
2011-12-16 10:07 8292首先到http://download.java.net/ope ...
相关推荐
编码规范系列(一):Eclipse Code Templates设置 - CSDN博客转 编码规范系列(一):Eclipse Code Templates设置0
Eclipse编码规范主要包括三个方面:设置Code Templates、Eclipse formatter、Checkstyle, 本篇主要介绍如何设置Code Templates,具体步骤如下: 打开Window->Preferences->Java->Code Style->Code Templates: ...
eclipse 标准 codetemplates.xml 代码模板,标准、简洁、好用
eclipse编码规范codetemplates和formatter的文件,直接配置使用。非常不错的格式
eclipse代码模板和注释模板,代码风格继承C语言,所有花括号都换行。eclipse代码模板和注释模板,代码风格继承C语言,所有花括号都换行。
笔者亲测 绝对好用放心下载 求攒 /** * @Description ${todo} ADD Description. * ClassName:${type_name} * * @Author 刘兆明 * @CreateDate ${date} ${time} * @version ${enclosing_...
java编码规范 codeTemplates
自己完善的代码注释风格,很实用,再也不用为换了电脑换了工具而担心了,一键导入,直接使用。
eclipse formatter和codetemplates java代码编写规范 eclipse formatter和codetemplates java代码编写规范
自己定义的注释模板,还算比较好用。用法是直接下载文件,在eclipse或myeclipse里面导入(preferences -- code templates -- comments -- import),使用的快捷键是 alt+shift+j,注释就自动加好了。
NULL 博文链接:https://xurichusheng.iteye.com/blog/1863410
自己写的一个Eclipse代码样式表codetemplates.xml ,可以在Eclipse中直接导入就好了,可根据需要修改成自己的代码样式。 使用方法: 工程->右键->Properties->Java code style -> code Templates-> import 就ok了。
Eclipse里面导入该模板,然后写类和方法的时候,就可以自动生成注释了 该模板经过测试,没有问题的
eclipse注释模板(codetemplates),可以导入自己的eclipse里面,不是很规范,仅供参考
codetemplates.xml
结合网上的资源和自己的项目需求,整理的模版,包括comments/code 方法:Preferences-->Java-->Code Style-->Code Templates 选择Import即可
eclipse format Templates
eclipse的formatter.xml codetemplates.xml,这两个文件,文件的配置自行百度eclipse代码格式化 formatter.xml codetemplates.xml
里面包括 eclipse注释 模板codetemplates.xml, eclipse-formatter.xml直接导入eclipse可以使用。 设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置...