原文地址:http://chenzhou123520.iteye.com/blog/1625629
从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之 前都会制定一系列的规范。俗话说约定优于配置,但是在执行过程中往往发现效果不是很好(主要是指编码规范这一方面)。所以我们不得不采取一些措施来协助我 们统一项目开发人员的编码风格。主要包括三个方面:设置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 stubCode-->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设置 - CSDN博客转 编码规范系列(一):Eclipse Code Templates设置0
从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有...主要包括三个方面:设置Code Templates、Eclipse formatter、Checkstyle,本篇主要介绍如何设置Code Templates,具体步骤如下
eclipse编码规范codetemplates和formatter的文件,直接配置使用。非常不错的格式
eclipse 标准 codetemplates.xml 代码模板,标准、简洁、好用
自己完善的代码注释风格,很实用,再也不用为换了电脑换了工具而担心了,一键导入,直接使用。
java编码规范 codeTemplates
eclipse formatter和codetemplates java代码编写规范 eclipse formatter和codetemplates java代码编写规范
自己写的一个Eclipse代码样式表codetemplates.xml ,可以在Eclipse中直接导入就好了,可根据需要修改成自己的代码样式。 使用方法: 工程->右键->Properties->Java code style -> code Templates-> import 就ok了。
Eclipse里面导入该模板,然后写类和方法的时候,就可以自动生成注释了 该模板经过测试,没有问题的
自己定义的注释模板,还算比较好用。用法是直接下载文件,在eclipse或myeclipse里面导入(preferences -- code templates -- comments -- import),使用的快捷键是 alt+shift+j,注释就自动加好了。
eclipse代码模板和注释模板,代码风格继承C语言,所有花括号都换行。eclipse代码模板和注释模板,代码风格继承C语言,所有花括号都换行。
Eclipse编码规范主要包括三个方面:设置Code Templates、Eclipse formatter、Checkstyle, 本篇主要介绍如何设置Code Templates,具体步骤如下: 打开Window->Preferences->Java->Code Style->Code Templates: ...
笔者亲测 绝对好用放心下载 求攒 /** * @Description ${todo} ADD Description. * ClassName:${type_name} * * @Author 刘兆明 * @CreateDate ${date} ${time} * @version ${enclosing_...
eclipse注释模板(codetemplates),可以导入自己的eclipse里面,不是很规范,仅供参考
codetemplates.xml
结合网上的资源和自己的项目需求,整理的模版,包括comments/code 方法:Preferences-->Java-->Code Style-->Code Templates 选择Import即可
NULL 博文链接:https://xurichusheng.iteye.com/blog/1863410
公司用的eclipse注释模板codetemplates,经过多次升级最终版本
里面包括 eclipse注释 模板codetemplates.xml, eclipse-formatter.xml直接导入eclipse可以使用。 设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置...
codeTemplates.xml,因为项目的需要,发现需要自己编写一个模板,从网上下载的感觉不太适合自己,于是就自己总结拼凑了一个,当然,你也可以下载之后根据你的需求再处理一下,有需要的拿走,不谢