设置注释模板的入口： Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍：

文件(Files)注释标签：

  1. /**
  2. * @Title: ${file_name}
  3. * @Package ${package_name}
  4. * @Description: ${todo}(用一句话描述该文件做什么)
  5. * @author A18ccms A18ccms_gmail_com
  6. * @date ${date} ${time}
  7. * @version V1.0
  8. */

类型(Types)注释标签（类的注释）：

  1. /**
  2. * @ClassName: ${type_name}
  3. * @Description: ${todo}(这里用一句话描述这个类的作用)
  4. * @author A18ccms a18ccms_gmail_com
  5. * @date ${date} ${time}
  6. *
  7. * ${tags}
  8. */

字段(Fields)注释标签：

  1. /**
  2. * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
  3. */

构造函数标签：

  1. /**
  2. * <p>Title: </p>
  3. * <p>Description: </p>
  4. * ${tags}
  5. */

方法(Constructor & Methods)标签：

  1. /**
  2. * @Title: ${enclosing_method}
  3. * @Description: ${todo}(这里用一句话描述这个方法的作用)
  4. * @param ${tags}    设定文件
  5. * @return ${return_type}    返回类型
  6. * @throws
  7. */

覆盖方法(Overriding Methods)标签：

  1. /* (非 Javadoc)
  2. * <p>Title: ${enclosing_method}</p>
  3. * <p>Description: </p>
  4. * ${tags}
  5. * ${see_to_overridden}
  6. */

代表方法(Delegate Methods)标签：

  1. /**
  2. * ${tags}
  3. * ${see_to_target}
  4. */

getter方法标签：

  1. /**
  2. * @return ${bare_field_name}
  3. */

setter方法标签：

  1. /**
  2. * @param ${param} 要设置的 ${bare_field_name}
  3. */

简单模板例子：

  1. <?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**  
    * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)  
    */  
  2.  
  3. </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
  4. * @return ${bare_field_name}
  5. */
  6. </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
  7. * <p>Title:${file_name} </p>
  8. * <p>Description: 构造函数</p>
  9. * ${tags}
  10. */
  11. </template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
  12. * @Title: ${file_name}
  13. * @Package ${package_name}
  14. * @Description: ${todo}(用一句话描述该文件做什么)
  15. * @author DAIGUANGJIU
  16. * @date ${date} ${time}
  17. * @version V1.0
  18. */
  19. </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
  20. * @param ${param} 要设置的 ${bare_field_name}
  21. */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
  22. * @author ${user}
  23. *
  24. * ${tags}
  25. */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
  26. * ${tags}
  27. * ${see_to_target}
  28. */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)
  29. * <p>Title: ${enclosing_method}</p>
  30. * <p>Description: </p>
  31. * ${tags}
  32. * ${see_to_overridden}
  33. */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
  34. * ${tags}
  35. */</template></templa
  36. <?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
  37. * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
  38. */
  39. </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
  40. * @return ${bare_field_name}
  41. */
  42. </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
  43. * <p>Title:${file_name} </p>
  44. * <p>Description: 构造函数</p>
  45. * ${tags}
  46. */
  47. </template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
  48. * @Title: ${file_name}
  49. * @Package ${package_name}
  50. * @Description: ${todo}(用一句话描述该文件做什么)
  51. * @author DAIGUANGJIU
  52. * @date ${date} ${time}
  53. * @version V1.0
  54. */
  55. </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
  56. * @param ${param} 要设置的 ${bare_field_name}
  57. */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
  58. * @author ${user}
  59. *
  60. * ${tags}
  61. */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
  62. * ${tags}
  63. * ${see_to_target}
  64. */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)
  65. * <p>Title: ${enclosing_method}</p>
  66. * <p>Description: </p>
  67. * ${tags}
  68. * ${see_to_overridden}
  69. */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
  70. * ${tags}
  71. */</template></templa

例子2：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <templates>
  3.     <template
  4.                 autoinsert="false"
  5.                 context="constructorcomment_context"
  6.                 deleted="false"
  7.                 description="Comment for created constructors"
  8.                 enabled="true"
  9.                 id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
  10.                 name="constructorcomment">
  11.     /**
  12.      * 创建一个新的实例 ${enclosing_type}.
  13.      *
  14.      * ${tags}
  15.      */
  16.     </template>
  17.     <template
  18.                 autoinsert="true"
  19.                 context="settercomment_context"
  20.                 deleted="false"
  21.                 description="Comment for setter method"
  22.                 enabled="true"
  23.                 id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
  24.                 name="settercomment">
  25.     /**
  26.      * @param ${param} the ${bare_field_name} to set
  27.      */
  28.     </template>
  29.     <template
  30.                 autoinsert="false"
  31.                 context="methodcomment_context"
  32.                 deleted="false"
  33.                 description="Comment for non-overriding methods"
  34.                 enabled="true"
  35.                 id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
  36.                 name="methodcomment">
  37.     /**
  38.      * 此方法描述的是：
  39.      * @author: wangxiongdx@163.com
  40.      * @version: ${date} ${time}
  41.      */
  42.     </template>
  43.     <template
  44.                 autoinsert="true"
  45.                 context="delegatecomment_context"
  46.                 deleted="false"
  47.                 description="Comment for delegate methods"
  48.                 enabled="true"
  49.                 id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
  50.                 name="delegatecomment">
  51.     /**
  52.      * ${tags}
  53.      * ${see_to_target}
  54.      */
  55.     </template>
  56.     <template
  57.                 autoinsert="false"
  58.                 context="filecomment_context"
  59.                 deleted="false"
  60.                 description="Comment for created Java files"
  61.                 enabled="true"
  62.                 id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
  63.                 name="filecomment">
  64.     /**
  65.      * 文件名：${file_name}
  66.      *
  67.      * 版本信息：
  68.      * 日期：${date}
  69.      * Copyright 足下 Corporation ${year}
  70.      * 版权所有
  71.      *
  72.      */
  73.     </template>
  74.     <template
  75.                 autoinsert="false"
  76.                 context="gettercomment_context"
  77.                 deleted="false"
  78.                 description="Comment for getter method"
  79.                 enabled="true"
  80.                 id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
  81.                 name="gettercomment">
  82.     /**
  83.      * ${bare_field_name}
  84.      *
  85.      * @return  the ${bare_field_name}
  86.      * @since   CodingExample Ver(编码范例查看) 1.0
  87.     */
  88.     </template>
  89.     <template
  90.                 autoinsert="true"
  91.                 context="overridecomment_context"
  92.                 deleted="false"
  93.                 description="Comment for overriding methods"
  94.                 enabled="true"
  95.                 id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
  96.                 name="overridecomment">
  97.     /* (non-Javadoc)
  98.      * ${see_to_overridden}
  99.      */
  100.     </template>
  101.     <template
  102.                 autoinsert="false"
  103.                 context="fieldcomment_context"
  104.                 deleted="false"
  105.                 description="Comment for fields"
  106.                 enabled="true"
  107.                 id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
  108.                 name="fieldcomment">
  109.     /**
  110.      * ${field}:${todo}（用一句话描述这个变量表示什么）
  111.      *
  112.      * @since Ver 1.1
  113.      */
  114.     </template>
  115.     <template
  116.                 autoinsert="false"
  117.                 context="typecomment_context"
  118.                 deleted="false"
  119.                 description="Comment for created types"
  120.                 enabled="true"
  121.                 id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
  122.                 name="typecomment">
  123.     /**
  124.      * 此类描述的是：
  125.      * @author: wangxiongdx@163.com
  126.      * @version: ${date} ${time}
  127.      */
  128.     </template>
  129. </templates>
  130. <?xml version="1.0" encoding="UTF-8"?>
  131. <templates>
  132.     <template
  133.                 autoinsert="false"
  134.                   context="constructorcomment_context"
  135.                 deleted="false"
  136.                 description="Comment for created constructors"
  137.                 enabled="true"
  138.                 id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
  139.                 name="constructorcomment">
  140.     /**
  141.      * 创建一个新的实例 ${enclosing_type}.
  142.      *
  143.      * ${tags}
  144.      */
  145.     </template>
  146.     <template
  147.                 autoinsert="true"
  148.                 context="settercomment_context"
  149.                 deleted="false"
  150.                 description="Comment for setter method"
  151.                 enabled="true"
  152.                 id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
  153.                 name="settercomment">
  154.     /**
  155.      * @param ${param} the ${bare_field_name} to set
  156.      */
  157.     </template>
  158.     <template
  159.                 autoinsert="false"
  160.                 context="methodcomment_context"
  161.                 deleted="false"
  162.                 description="Comment for non-overriding methods"
  163.                 enabled="true"
  164.                 id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
  165.                 name="methodcomment">
  166.     /**
  167.      * 此方法描述的是：
  168.      * @author: wangxiongdx@163.com
  169.      * @version: ${date} ${time}
  170.      */
  171.     </template>
  172.     <template
  173.                 autoinsert="true"
  174.                 context="delegatecomment_context"
  175.                 deleted="false"
  176.                 description="Comment for delegate methods"
  177.                 enabled="true"
  178.                 id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
  179.                 name="delegatecomment">
  180.     /**
  181.      * ${tags}
  182.      * ${see_to_target}
  183.      */
  184.     </template>
  185.     <template
  186.                 autoinsert="false"
  187.                 context="filecomment_context"
  188.                 deleted="false"
  189.                 description="Comment for created Java files"
  190.                 enabled="true"
  191.                 id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
  192.                 name="filecomment">
  193.     /**
  194.      * 文件名：${file_name}
  195.      *
  196.      * 版本信息：
  197.      * 日期：${date}
  198.      * Copyright 足下 Corporation ${year}
  199.      * 版权所有
  200.      *
  201.      */
  202.     </template>
  203.     <template
  204.                 autoinsert="false"
  205.                 context="gettercomment_context"
  206.                 deleted="false"
  207.                 description="Comment for getter method"
  208.                 enabled="true"
  209.                 id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
  210.                 name="gettercomment">
  211.     /**
  212.      * ${bare_field_name}
  213.      *
  214.      * @return  the ${bare_field_name}
  215.      * @since   CodingExample Ver(编码范例查看) 1.0
  216.     */
  217.     </template>
  218.  
  219.     <template
  220.                 autoinsert="true"
  221.                 context="overridecomment_context"
  222.                 deleted="false"
  223.                 description="Comment for overriding methods"
  224.                 enabled="true"
  225.                 id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
  226.                 name="overridecomment">
  227.     /* (non-Javadoc)
  228.      * ${see_to_overridden}
  229.      */
  230.     </template>
  231.     <template
  232.                 autoinsert="false"
  233.                 context="fieldcomment_context"
  234.                 deleted="false"
  235.                 description="Comment for fields"
  236.                 enabled="true"
  237.                 id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
  238.                 name="fieldcomment">
  239.     /**
  240.      * ${field}:${todo}（用一句话描述这个变量表示什么）
  241.      *
  242.      * @since Ver 1.1
  243.      */
  244.     </template>
  245.     <template
  246.                 autoinsert="false"
  247.                 context="typecomment_context"
  248.                 deleted="false"
  249.                 description="Comment for created types"
  250.                 enabled="true"
  251.                 id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
  252.                 name="typecomment">
  253.     /**
  254.      * 此类描述的是：
  255.      * @author: wangxiongdx@163.com
  256.      * @version: ${date} ${time}
  257.      */
  258.     </template>
  259. </templates>

此文转载于http://www.cnblogs.com/senzjx/archive/2009/09/21/1570950.html

Eclipse Java注释模板设置详解的更多相关文章

  1. 【转】Eclipse Java注释模板设置详解

    Eclipse Java注释模板设置详解   设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后 ...

  2. Eclipse Java注释模板设置详解，更改 ${user}和${date}

    修改MyEclipse eclipse 注释的作者名字 转自:http://www.oschina.net/question/158170_31311 在eclipse/myeclipse中,当我们去 ...

  3. [转]Eclipse Java注释模板设置详解

    原文链接:http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx 设置注释模板的入口: Window->Preference-&g ...

  4. Eclipse Java注释模板设置详解以及版权声明

    网上的Eclipse注释模板,在这里稍稍整理一些比较常用的. 编辑注释模板的方法:Window->Preference->Java->Code Style->Code Temp ...

  5. 170828、Eclipse Java注释模板设置详解以及版权声明

    编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素 ...

  6. Java注释模板设置详解

    设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元 ...

  7. eclipse java 注释模板配置详解

    设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元 ...

  8. 【转载】 Eclipse注释模板设置详解

     Eclipse注释模板设置详解 网站推荐: 金丝燕网(主要内容是 Java 相关) 木秀林网(主要内容是消息队列)

  9. "佛祖保佑 永无bug" 注释模板设置详解(仅供娱乐)

    1.注释模板效果图 今天在网上看到一段有趣的注释,佛祖保佑 永无bug, 效果如下图所示:  代码如下所示: /** * _ooOoo_ * o8888888o * 88" . " ...

随机推荐

  1. Sensitive directory/file Integrity Monitoring and Checking

    catalogue . OSSEC . HashSentry: Host-Based IDS in Python . Afick . 检测流程 1. OSSEC OSSEC is an Open So ...

  2. django的cookie和session以及内置信号、缓存

    cookie和session cookie和session的作用: cookie和session都记录了客户端的某种状态,用来跟踪用户访问网站的整个回话.两者最大的区别是cookie的信息是存放在浏览 ...

  3. js浏览器对象模型（BOM）

    浏览器对象模型(Browser Object Model,BOM):浏览器为js提供的对象集合. 1 windows对象 windows对象:表示浏览器的框架以及与其相关的内容,比如滚动条和导航栏图标 ...

  4. JQ-动画合集（ing...）

    一:给向上按钮加动画,让页面卷回上面而不是生硬跳转.js $('#topBtn').click(function(){ $('html,body').animate({scrollTop: '0px' ...

  5. Premiere使用整理

    整理部分自己在使用Premiere CC中遇到的问题和注意点. 1. 新建序列 若是录屏文件,可选择已加入到项目中的视频文件,点击 文件-新建-来自剪辑的序列. 2. 新建字幕 用于在视频中添加文字. ...

  6. 使用rsync+inotify同步两台服务器文件

    目标功能:将B服务器文件同步到A服务器 A服务器rsyncd.conf配置 权限600 A服务器rsyncd.pas文件配置  权限600 同步文件路径 /data/wwwroot/shen/  权限 ...

  7. Android SDK升级后报错error when loading the sdk 发现了元素 d:skin 开头无效内容

    把错误位置的devices.xml这个文件删除,再把sdk里面tools\lib下的这个文件拷贝到你删除的那个文件夹里,重启eclipse

  8. 《JavaScript高级程序设计（第3版）》笔记-序

    很少看书,不喜欢看书,主要是上学时总坐不住,没有多大定性,一本书可以两天看完,随便翻翻,也可以丢在角落里几个月不去动一下. 上次碰到了<JavaScript高级程序设计(第3版)>感觉真的 ...

  9. CH模拟赛 还教室

    /* 区间操作,可以推一推式子,方差为平方的平均数-平均数的平方,维护区间和与区间平方和,平方和的维护方法类似,式子推一推就行了,注意约分 */ #include<iostream> #i ...

  10. Apache Torque入门学习

    Introduction Apache Torque is an object-relational mapper for java. In other words, Torque lets you ...