eclipse/myeclipse注释行模板的安装步骤

注释比代码还重要??
当然!在一个项目的完整的生命周期中,其维护费用,往往是其开发费用的数倍。
因此项目的可维护性、可复用性是衡量一个项目好坏的关键。而注释行则是可维护性中必不可少的一环。

安装方法:
打开eclipse/myeclipse
选择 window-->Preferences-->JAVA-->Code-->Code Templates 右边点Import 选择你写好的模板.xml文件

导入进去即可

使用方法:
创建新类的时候,勾上“Generate comments”选项即可。新创建的类中,自动添加了你的注释模板中定义好了的注释。

下面是一个注释行模板codetemplates.xml,可以直接导入使用。贴出源码供大家参考一下


  1. <?xml version="1.0" encoding="UTF-8"?><templates><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">  
  2. /**   
  3.  * 创建一个新的实例 ${enclosing_type}.   
  4.  *   
  5.  * ${tags}   
  6.  */</template><template autoinsert="true" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**   
  7.  * @param ${param} the ${bare_field_name} to set   
  8.  */</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">/**   
  9.   
  10.  * ${enclosing_method}(这里用一句话描述这个方法的作用)   
  11.   
  12.  * TODO(这里描述这个方法适用条件 – 可选)   
  13.   
  14.  * TODO(这里描述这个方法的执行流程 – 可选)   
  15.   
  16.  * TODO(这里描述这个方法的使用方法 – 可选)   
  17.   
  18.  * TODO(这里描述这个方法的注意事项 – 可选)   
  19.   
  20.  * @param   name   
  21.   
  22.  * @param  @return    设定文件   
  23.   
  24.  * @return String    DOM对象   
  25.   
  26.  * @Exception 异常对象   
  27.   
  28.  * @since  CodingExample Ver(编码范例查看) 1.1   
  29.   
  30. */</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">/**   
  31.  * ${tags}   
  32.  * ${see_to_target}   
  33.  */</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">/**   
  34.  * 文件名:${file_name}   
  35.  *   
  36.  * 版本信息:   
  37.  * 日期:${date}   
  38.  * Copyright 足下 Corporation ${year}    
  39.  * 版权所有   
  40.  *   
  41.  */</template><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">/**   
  42.  * ${bare_field_name}   
  43.  *   
  44.  * @return  the ${bare_field_name}   
  45.  * @since   CodingExample Ver(编码范例查看) 1.0   
  46. */   
  47. </template><template autoinsert="true" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (non-Javadoc)   
  48.  * ${see_to_overridden}   
  49.  */</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">/**   
  50.  * ${field}:${todo}(用一句话描述这个变量表示什么)   
  51.  *   
  52.  * @since Ver 1.1   
  53.  */   
  54. </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">/**   
  55.  *    
  56.  * 项目名称:${project_name}   
  57.  * 类名称:${type_name}   
  58.  * 类描述:   
  59.  * 创建人:${user}   
  60.  * 创建时间:${date} ${time}   
  61.  * 修改人:${user}   
  62.  * 修改时间:${date} ${time}   
  63.  * 修改备注:   
  64.  * @version    
  65.  *    
  66.  */</template></templates>  

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值