eclipse/myeclipse注释模板的修改

本文介绍如何在Eclipse中设置Java代码的各种注释模板,包括文件、类型、字段、构造函数等,帮助开发者快速生成规范化的注释。
[java]  view plain copy print ?
  1. Window --> Java --> Code Style --> Code Templates --> Comments --> types --> Edit   
  2.   
  3. /**    
  4. *     
  5. * 项目名称:${project_name}    
  6. * 类名称:${type_name}    
  7. * 类描述:    
  8. * 创建人:${user}    
  9. * 创建时间:${date} ${time}    
  10. * 修改人:${user}    
  11. * 修改时间:${date} ${time}    
  12. * 修改备注:    
  13. * @version     
  14. *     
  15. */   
  16.   
  17. ----------------------------------------------------------------------------------------------------------   
  18. 设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:   
  19. 文件(Files)注释标签:   
  20. /**   
  21. * @Title: ${file_name}  
  22. * @Package ${package_name}  
  23. * @Description: ${todo}(用一句话描述该文件做什么)  
  24. * @author A18ccms A18ccms_gmail_com   
  25. * @date ${date} ${time}  
  26. * @version V1.0   
  27. */   
  28.   
  29. 类型(Types)注释标签(类的注释):   
  30.   
  31. /**  
  32. * @ClassName: ${type_name}  
  33. * @Description: ${todo}(这里用一句话描述这个类的作用)  
  34. * @author A18ccms a18ccms_gmail_com  
  35. * @date ${date} ${time}  
  36. * ${tags}  
  37. */   
  38.   
  39. 字段(Fields)注释标签:   
  40.   
  41. /**  
  42. * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)  
  43. */   
  44.   
  45. 构造函数标签:   
  46.   
  47. /**  
  48. * <p>Title: </p>  
  49. * <p>Description: </p>  
  50. * ${tags}  
  51. */   
  52.   
  53. 方法(Constructor & Methods)标签:   
  54.   
  55. /**  
  56. * @Title: ${enclosing_method}  
  57. * @Description: ${todo}(这里用一句话描述这个方法的作用)  
  58. * @param ${tags}    设定文件  
  59. * @return ${return_type}    返回类型  
  60. * @throws  
  61. */   
  62.   
  63. 覆盖方法(Overriding Methods)标签:   
  64.   
  65. /* (非 Javadoc)  
  66. * <p>Title: ${enclosing_method}</p>  
  67. * <p>Description: </p>  
  68. * ${tags}  
  69. * ${see_to_overridden}  
  70. */   
  71.   
  72. 代表方法(Delegate Methods)标签:   
  73.   
  74. /**  
  75. * ${tags}  
  76. * ${see_to_target}  
  77. */   
  78.   
  79. getter方法标签:   
  80.   
  81. /**  
  82. * @return ${bare_field_name}  
  83. */   
  84.   
  85. setter方法标签:   
  86.   
  87. /**  
  88. * @param ${param} 要设置的 ${bare_field_name}  
  89. */   
  90.   
  91. 简单模板例子:   
  92.   
  93. view plaincopy to clipboardprint?   
  94.   
  95. <?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">/**  
  96. * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)  
  97. */   
  98.   
  99. </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**  
  100. * @return ${bare_field_name}  
  101. */   
  102.   
  103. </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**  
  104. * <p>Title:${file_name} </p>  
  105. * <p>Description: 构造函数</p>  
  106. * ${tags}  
  107. */   
  108.   
  109. </template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**    
  110.  
  111. * @Title: ${file_name}  
  112. * @Package ${package_name}  
  113. * @Description: ${todo}(用一句话描述该文件做什么)  
  114. * @author DAIGUANGJIU     
  115. * @date ${date} ${time}  
  116. * @version V1.0    
  117. */   
  118.   
  119. </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**  
  120.  
  121. * @param ${param} 要设置的 ${bare_field_name}  
  122. */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**  
  123. * @author ${user}  
  124.  
  125. * ${tags}  
  126. */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**  
  127. * ${tags}  
  128. * ${see_to_target}  
  129. */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)  
  130. * <p>Title: ${enclosing_method}</p>  
  131. * <p>Description: </p>  
  132. * ${tags}  
  133. * ${see_to_overridden}  
  134. */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**  
  135. * ${tags}  
  136. */</template></templa   
  137. <?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">/**  
  138. * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)  
  139. */   
  140.   
  141. </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**  
  142. * @return ${bare_field_name}  
  143. */   
  144.   
  145. </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**  
  146. * <p>Title:${file_name} </p>  
  147. * <p>Description: 构造函数</p>  
  148. * ${tags}  
  149. */   
  150.   
  151. </template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**  
  152. * @Title: ${file_name}  
  153. * @Package ${package_name}  
  154. * @Description: ${todo}(用一句话描述该文件做什么)  
  155. * @author DAIGUANGJIU   
  156. * @date ${date} ${time}  
  157. * @version V1.0  
  158. */   
  159.   
  160. </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**  
  161.  
  162. * @param ${param} 要设置的 ${bare_field_name}  
  163.  
  164. */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**  
  165. * @author ${user}  
  166.  
  167. * ${tags}  
  168. */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**  
  169. * ${tags}  
  170. * ${see_to_target}  
  171. */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)  
  172. * <p>Title: ${enclosing_method}</p>  
  173. * <p>Description: </p>  
  174. * ${tags}  
  175. * ${see_to_overridden}  
  176. */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**  
  177.  
  178. * ${tags}  
  179.  
  180. */</template></templa   
  181.   
  182. 例子2:   
  183.   
  184. view plaincopy to clipboardprint?   
  185. <?xml version="1.0" encoding="UTF-8"?>   
  186. <templates>   
  187.     <template     
  188.                 autoinsert="false"     
  189.                 context="constructorcomment_context"     
  190.                 deleted="false"     
  191.                 description="Comment for created constructors"     
  192.                 enabled="true"     
  193.                 id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"   
  194.                 name="constructorcomment">   
  195.   
  196.     /**   
  197.      * 创建一个新的实例 ${enclosing_type}.   
  198.      *   
  199.      * ${tags}   
  200.      */    
  201.   
  202.     </template>   
  203.   
  204.     <template     
  205.                 autoinsert="true"     
  206.                 context="settercomment_context"   
  207.                 deleted="false"     
  208.                 description="Comment for setter method"     
  209.                 enabled="true"     
  210.                 id="org.eclipse.jdt.ui.text.codetemplates.settercomment"     
  211.                 name="settercomment">   
  212.   
  213.     /**   
  214.      * @param ${param} the ${bare_field_name} to set   
  215.      */    
  216.   
  217.     </template>   
  218.   
  219.     <template   
  220.                 autoinsert="false"     
  221.                 context="methodcomment_context"     
  222.                 deleted="false"     
  223.                 description="Comment for non-overriding methods"     
  224.                 enabled="true"     
  225.                 id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"     
  226.                 name="methodcomment">   
  227.   
  228.     /**   
  229.      * 此方法描述的是:   
  230.      * @author: wangxiongdx@163.com   
  231.      * @version: ${date} ${time}   
  232.      */    
  233.   
  234.     </template>   
  235.   
  236.     <template     
  237.                 autoinsert="true"     
  238.                 context="delegatecomment_context"     
  239.                 deleted="false"     
  240.                 description="Comment for delegate methods"     
  241.                 enabled="true"     
  242.                 id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"     
  243.                 name="delegatecomment">   
  244.   
  245.     /**   
  246.      * ${tags}   
  247.      * ${see_to_target}   
  248.      */    
  249.   
  250.     </template>   
  251.   
  252.     <template   
  253.                 autoinsert="false"     
  254.                 context="filecomment_context"     
  255.                 deleted="false"     
  256.                 description="Comment for created Java files"     
  257.                 enabled="true"     
  258.                 id="org.eclipse.jdt.ui.text.codetemplates.filecomment"     
  259.                 name="filecomment">   
  260.   
  261.     /**   
  262.      * 文件名:${file_name}   
  263.      *   
  264.      * 版本信息:   
  265.      * 日期:${date}   
  266.      * Copyright 足下 Corporation ${year}    
  267.      * 版权所有   
  268.      *   
  269.      */    
  270.   
  271.     </template>   
  272.   
  273.     <template     
  274.                 autoinsert="false"     
  275.                 context="gettercomment_context"     
  276.                 deleted="false"     
  277.                 description="Comment for getter method"     
  278.                 enabled="true"     
  279.                 id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"     
  280.                 name="gettercomment">   
  281.   
  282.     /**   
  283.      * ${bare_field_name}   
  284.      *   
  285.      * @return the ${bare_field_name}   
  286.      * @since   CodingExample Ver(编码范例查看) 1.0   
  287.     */    
  288.     </template>   
  289.   
  290.   
  291.   
  292.     <template     
  293.                 autoinsert="true"     
  294.                 context="overridecomment_context"     
  295.                 deleted="false"     
  296.                 description="Comment for overriding methods"     
  297.                 enabled="true"     
  298.                 id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"     
  299.                 name="overridecomment">   
  300.   
  301.     /* (non-Javadoc)   
  302.      * ${see_to_overridden}   
  303.      */    
  304.     </template>   
  305.   
  306.     <template     
  307.                 autoinsert="false"     
  308.                 contet="fieldcomment_context"     
  309.                 deleted="false"     
  310.                 description="Comment for fields"     
  311.                 enabled="true"     
  312.                 id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"     
  313.                 name="fieldcomment">   
  314.   
  315.     /**   
  316.      * ${field}:${todo}(用一句话描述这个变量表示什么)   
  317.      *   
  318.      * @since Ver 1.1   
  319.      */    
  320.   
  321.     </template>  
  322.     <template     
  323.                 autoinsert="false"     
  324.                 context="typecomment_context"     
  325.                 deleted="false"     
  326.                 description="Comment for created types"     
  327.                 enabled="true"     
  328.                 id="org.eclipse.jdt.ui.text.codetemplates.typecomment"     
  329.                 name="typecomment">   
  330.   
  331.     /**   
  332.      * 此类描述的是:   
  333.       * @author: wangxiongdx@163.com   
  334.      * @version: ${date} ${time}    
  335.      */    
  336.     </template>   
  337. </templates>   
AI-PPT 一键生成 PPT:用户输入主题关键词,AI-PPT 可快速生成完整 PPT,涵盖标题、正文、段落结构等,还支持对话式生成,用户可在 AI 交互窗口边查看边修改。 文档导入转 PPT:支持导入 Word、Excel、PDF 等多种格式文档,自动解析文档结构,将其转换为结构清晰、排版规范的 PPT,有保持原文和智能优化两种模式。 AI-PPT 对话 实时问答:用户上传 PPT 或 PPTX 文件后,可针对演示内容进行提问,AI 实时提供解答,帮助用户快速理解内容。 多角度内容分析:对 PPT 内容进行多角度分析,提供全面视野,帮助用户更好地把握内容结构和重点。 多语言对话支持:支持多语言对话,打破语言障碍,方便不同语言背景的用户使用。 AI - 绘图 文生图:用户输入文字描述,即可生成符合语义的不同风格图像,如油画、水彩、中国画等,支持中英文双语输入。 图生图:用户上传图片并输入描述,AI - 绘图能够根据参考图和描述生成新的风格化图像,适用于需要特定风格或元素的创作需求。 图像编辑:提供如 AI 超清、AI 扩图、AI 无痕消除等功能,用户可以上传图片进行细节修改和优化,提升图片质量。 AI - 文稿 文案生成:能够根据用户需求生成多种类型的文章,如市场营销文案、技术文档、内部沟通内容等,提升文案质量和创作效率。 文章润色:对已有文章进行改善和优化,包括语言表达、逻辑连贯性、内容流畅度等方面,使文章更符合用户期望和风格。 文章续写:AI 技术理解文本语境,为用户提供新的想法、补充资料或更深层次的见解,帮助用户丰富文档内容。 AI - 医生 智能健康咨询:包括症状自查,用户输入不适症状,AI 结合病史等信息提供疾病可能性分析与初步建议;用药指导,支持查询药品适应症、禁忌症等,并预警潜在冲突;中医辨证,提供体质辨识与调理建议。 医学报告解读:用户上传体检报告
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值