编码规范系列（一）：Eclipse Code Templates设置

最新推荐文章于 2023-03-30 11:56:14 发布
最新推荐文章于 2023-03-30 11:56:14 发布
阅读量801 收藏
点赞数
分类专栏： 开发工具 文章标签： eclipse templates

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

 

打开Window->Preferences->Java->Code Style->Code Templates

Eclipse设置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.  */  
/**
 * 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类注释）

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

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

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

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

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.  */  
/**
 * ${enclosing_method}:(这里用一句话描述这个方法的作用). <br/>
 * ${todo}(这里描述这个方法适用条件 – 可选).<br/>
 * ${todo}(这里描述这个方法的执行流程 – 可选).<br/>
 * ${todo}(这里描述这个方法的使用方法 – 可选).<br/>
 * ${todo}(这里描述这个方法的注意事项 – 可选).<br/>
 *
 * @author ${user}
 * ${tags}
 * @since JDK 1.6
 */

Comments-->Overriding methods（重写方法注释）

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

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

Java代码 复制代码  收藏代码
  1. /** 
  2.  * ${tags} 
  3.  * ${see_to_target} 
  4.  */  
/**
 * ${tags}
 * ${see_to_target}
 */

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

Java代码 复制代码  收藏代码
  1. /** 
  2.  * ${bare_field_name}. 
  3.  * 
  4.  * @return  the ${bare_field_name} 
  5.  * @since   JDK 1.6 
  6.  */  
/**
 * ${bare_field_name}.
 *
 * @return  the ${bare_field_name}
 * @since   JDK 1.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.  */  
/**
 * ${param}.
 *
 * @param   ${param}    the ${bare_field_name} to set
 * @since   JDK 1.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.   
  11. ${package_declaration}  
  12. /** 
  13.  * ClassName:${type_name} <br/> 
  14.  * Function: ${todo} ADD FUNCTION. <br/> 
  15.  * Reason:   ${todo} ADD REASON. <br/> 
  16.  * Date:     ${date} ${time} <br/> 
  17.  * @author   ${user} 
  18.  * @version   
  19.  * @since    JDK 1.6 
  20.  * @see       
  21.  */  
  22. ${typecomment}  
  23. ${type_declaration}  
/**
 * 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（方法体模板）

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

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

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

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

Java代码 复制代码  收藏代码
  1. return ${field};  
return ${field};

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

Java代码 复制代码  收藏代码
  1. ${field} = ${param};  
${field} = ${param};

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

Java代码 复制代码  收藏代码
  1. // ${todo} Auto-generated catch block  
  2. ${exception_var}.printStackTrace();  
// ${todo} Auto-generated catch block
${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.   
  61. ${package_declaration}  
  62. /**  
  63.  * ClassName:${type_name} &lt;br/&gt;  
  64.  * Function: ${todo} ADD FUNCTION. &lt;br/&gt;  
  65.  * Reason:   ${todo} ADD REASON. &lt;br/&gt;  
  66.  * Date:     ${date} ${time} &lt;br/&gt;  
  67.  * @author   ${user}  
  68.  * @version    
  69.  * @since    JDK 1.6  
  70.  * @see        
  71.  */  
  72. ${typecomment}  
  73. ${type_declaration}  
  74. </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">  
  75. </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">  
  76. </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">  
  77. </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">  
  78. </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">  
  79. // ${todo} Auto-generated catch block  
  80. ${exception_var}.printStackTrace();  
  81. </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">  
  82. // ${todo} Auto-generated method stub  
  83. ${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">  
  84. ${body_statement}  
  85. // ${todo} Auto-generated constructor stub  
  86. </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就可以方便地生成我们自定义的注释，开发人员也容易接受！

点击打开链接

chendc201
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Myeclipse代码生成模板(xml配置文件)
leixingbang的专栏
10-29 1506
将以下xml文件，任意取名。myeclipse中，打开preference->java->codeTemplates->import即可 /* (non-Javadoc) * ${see_to_overridden} *//** * */ /** *******************************************************
Eclipse中的codetemplates.xml
weixin_33753845的博客
03-18 126
自己写的一个Eclipse代码样式表codetemplates.xml ，可以在Eclipse中直接导入就好了，可根据需要修改成自己的代码样式。 使用方法： 工程-&gt;右键-&gt;Properties-&gt;Java code style -&gt; code Templates-&gt; import 就ok了。 点击下载codetemplates...
基于STM32Cube_FW_L4包，新建项目(keil)和移植LL库
m0_46523886的博客
03-30 1298
本文介绍如何使用STM32Cube_FW_L4，在keil中新建并移植必要文件，并移植LL库。
Eclipse Code Templates设置
weixin_34395205的博客
07-20 324
从工作开始，经历了几个项目的开发，现在的项目一般都是一个团队共同开发，而每个人都有自己的编码习惯，为了统一格式，项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置，但是在执行过程中往往发现效果不是很好（主要是指编码规范这一方面）。所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格。主要包括三个方面：设置Code Templates、Eclipse formatter、Chec...
Eclipse配置阿里Code Format - 使用阿里Java Format 模板
u010426961的博客
02-17 921
Eclipse配置阿里Code Format - 使用阿里Java Format 模板_Raymond_Love的博客-CSDN博客 1. 配置文件下载地址 https://github.com/alibaba/p3c/tree/master/p3c-formatter 下载下面两个文件： eclipse-codestyle.xml eclipse-codetemplate.xml 2. 配置Eclipse 2.1 Set Window --> Preferences 2.1.1 General
eclipse-编码规范系列（一）：Eclipse Code Templates设置 - CSDN博客1
08-03
编码规范系列（一）：Eclipse Code Templates设置 - CSDN博客转 编码规范系列（一）：Eclipse Code Templates设置0
eclipse Code Templates
07-20
笔者亲测 绝对好用放心下载 求攒 /** * @Description ${todo} ADD Description. * ClassName:${type_name} * * @Author 刘兆明 * @CreateDate ${date} ${time} * @version ${enclosing_...
eclipse_codetemplates.rar
07-23
自己完善的代码注释风格，很实用，再也不用为换了电脑换了工具而担心了，一键导入，直接使用。
java编码规范 codeTemplates
09-29
java编码规范 codeTemplates
codetemplates.xml(Eclipse 注释代码模板文件comments/code)
01-07
结合网上的资源和自己的项目需求，整理的模版，包括comments/code 方法:Preferences-->Java-->Code Style-->Code Templates 选择Import即可
eclipse-codetemplate.xml
05-17
eclipse-codetemplate.xml
eclipse代码模板codetemplates.xml
05-22
eclipse 标准 codetemplates.xml 代码模板，标准、简洁、好用
eclipse 注释模板codetemplates.xml
09-18
windows-》preference—》java-》code style-》code template，点击import按钮。 导入成功后，点击comments选项，可以查看各个不同位置的注释，比如文件注释、变量注释、函数注释等。展示样式在Pattern下面的文本框展示。注意只能查看不能修改哈。
codetemplates.xml下载(Eclipse 注释代码模板文件)
03-04
codetemplates.xml下载(Eclipse 注释代码模板文件)
idea-基本配置
蓝天白云
08-14 552
双击选中一个变量，及高亮显示相同的变量
Eclipse 代码模板
unber的博客
02-21 660
Eclipse 提供了通过定义和使用代码模板来提高工作效率与代码可预测性的能力。
代码开发规范-codetemplates.xml
weixin_38300488的博客
05-14 429
由于一个项目肯定有多个开发人员，所以代码风格必须统一，不然不管从视觉还是得后期维护上上都有不便之处。所以需要编写codetemplates.xml，让开发人员导入，保持风格一致。 codetemplates.xml模板导出 Window–>Preferences–>Java–>Code Style --> Code Templates --> Comments codetemplates.xml模板编写 <?xml version="1.0" encodi
ecplise导入maven项目xml文件报错
悲伤的测试开发的博客
07-26 876
1ecplise导入maven项目xml文件报错 这个时候我们先看一下我们导入的tomcat是否与我们所安装的一直，因为这个时候本身自带的运行环境与我们的不一致 打开后我们点击下面把他项目自带的运行环境删除，然后添加我们自己配置的运行环境 这样我们就添加完成了点击apply然后点击apply and Close关闭掉九阳我们的运行环境就没有问题了 还有的说但是的xml文件头会报错 这个时候我们点击maven项目，进行更新点击 再弹出的对话框中勾选中强制更新，如图 这样我们的项目就没有问题了
XSLT中<xsl:apply-templates>的使用方式
最新发布
06-10
在XSLT中，<xsl:apply-templates>用于将当前节点或节点集合转发到模板匹配规则中，以便进行进一步的处理。它的使用方式如下： 1. 选择要应用模板的节点或节点集合。 2. 使用<xsl:apply-templates>元素来转发选择的节点或节点集合到相应的模板中。 3. 在模板中，使用<xsl:template>元素来匹配<xsl:apply-templates>中转发的节点或节点集合，并定义相应的处理规则。 例如，以下XSLT代码将会匹配所有的book节点，并将其转发到名为"book-template"的模板中进行处理： ```xml <xsl:template match="bookstore"> <xsl:apply-templates select="book"/> </xsl:template> <xsl:template match="book" name="book-template"> <!-- 处理book节点的内容 --> </xsl:template> ``` 在这个例子中，<xsl:apply-templates>元素选择了所有的book节点，并将它们转发到名为"book-template"的模板中进行处理。在"book-template"模板中，我们可以定义对book节点的处理规则。 需要注意的是，如果没有匹配到任何模板，则默认使用空模板（即不做任何处理）。如果需要避免这种情况，可以在<xsl:apply-templates>元素中使用"mode"属性指定一个非空的模板名称。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值