`
liyf155
  • 浏览: 128284 次
  • 性别: Icon_minigender_1
  • 来自: 广州
社区版块
存档分类
最新评论

eclipse 注释模板

eclipse模板注释eclipse注释模板 
阅读更多

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

文件(Files)注释标签：

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

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

/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
*
* ${tags}
*/


字段(Fields)注释标签：

/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
构造函数标签：

/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/


方法(Constructor & Methods)标签：

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


覆盖方法(Overriding Methods)标签：

/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/


代表方法(Delegate Methods)标签：

/**
* ${tags}
* ${see_to_target}
*/
getter方法标签：

/**
* @return ${bare_field_name}
*/

setter方法标签：

/**
* @param ${param} 要设置的 ${bare_field_name}
*/

 

简单模板例子：

 

 

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

文件(Files)注释标签：

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

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

/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
*
* ${tags}
*/


字段(Fields)注释标签：

/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
构造函数标签：

/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/


方法(Constructor & Methods)标签：

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


覆盖方法(Overriding Methods)标签：

/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/


代表方法(Delegate Methods)标签：

/**
* ${tags}
* ${see_to_target}
*/
getter方法标签：

/**
* @return ${bare_field_name}
*/

setter方法标签：

/**
* @param ${param} 要设置的 ${bare_field_name}
*/

 

简单模板例子：

 

[java] view plaincopyprint?
  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">/**
  2. * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
  3. */
  4. </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
  5. * @return ${bare_field_name}
  6. */
  7. </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
  8. * <p>Title:${file_name} </p>
  9. * <p>Description: 构造函数</p>
  10. * ${tags}
  11. */
  12. </template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
  13. * @Title: ${file_name}
  14. * @Package ${package_name}
  15. * @Description: ${todo}(用一句话描述该文件做什么)
  16. * @author DAIGUANGJIU
  17. * @date ${date} ${time}
  18. * @version V1.0
  19. */
  20. </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
  21. * @param ${param} 要设置的 ${bare_field_name}
  22. */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
  23. * @author ${user}
  24. *
  25. * ${tags}
  26. */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
  27. * ${tags}
  28. * ${see_to_target}
  29. */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)
  30. * <p>Title: ${enclosing_method}</p>
  31. * <p>Description: </p>
  32. * ${tags}
  33. * ${see_to_overridden}
  34. */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
  35. * ${tags}
  36. */</template></templa

 

 

 

例子2：

 

[xhtml] view plaincopyprint?
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <templates>
  4. <template
  5. autoinsert="false"
  6. context="constructorcomment_context"
  7. deleted="false"
  8. description="Comment for created constructors"
  9. enabled="true"
  10. id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
  11. name="constructorcomment">
  12. /**
  13. * 创建一个新的实例 ${enclosing_type}.
  14. *
  15. * ${tags}
  16. */
  17. </template>
  19. <template
  20. autoinsert="true"
  21. context="settercomment_context"
  22. deleted="false"
  23. description="Comment for setter method"
  24. enabled="true"
  25. id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
  26. name="settercomment">
  27. /**
  28. * @param ${param} the ${bare_field_name} to set
  29. */
  30. </template>
  33. <template
  34. autoinsert="false"
  35. context="methodcomment_context"
  36. deleted="false"
  37. description="Comment for non-overriding methods"
  38. enabled="true"
  39. id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
  40. name="methodcomment">
  41. /**
  42. * 此方法描述的是：
  43. * @author: wangxiongdx@163.com
  44. * @version: ${date} ${time}
  45. */
  46. </template>
  49. <template
  50. autoinsert="true"
  51. context="delegatecomment_context"
  52. deleted="false"
  53. description="Comment for delegate methods"
  54. enabled="true"
  55. id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
  56. name="delegatecomment">
  57. /**
  58. * ${tags}
  59. * ${see_to_target}
  60. */
  61. </template>
  64. <template
  65. autoinsert="false"
  66. context="filecomment_context"
  67. deleted="false"
  68. description="Comment for created Java files"
  69. enabled="true"
  70. id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
  71. name="filecomment">
  72. /**
  73. * 文件名：${file_name}
  74. *
  75. * 版本信息：
  76. * 日期：${date}
  77. * Copyright 足下 Corporation ${year}
  78. * 版权所有
  79. *
  80. */
  81. </template>
  84. <template
  85. autoinsert="false"
  86. context="gettercomment_context"
  87. deleted="false"
  88. description="Comment for getter method"
  89. enabled="true"
  90. id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
  91. name="gettercomment">
  92. /**
  93. * ${bare_field_name}
  94. *
  95. * @return the ${bare_field_name}
  96. * @since CodingExample Ver(编码范例查看) 1.0
  97. */
  98. </template>
  100. <template
  101. autoinsert="true"
  102. context="overridecomment_context"
  103. deleted="false"
  104. description="Comment for overriding methods"
  105. enabled="true"
  106. id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
  107. name="overridecomment">
  108. /* (non-Javadoc)
  109. * ${see_to_overridden}
  110. */
  111. </template>
  114. <template
  115. autoinsert="false"
  116. context="fieldcomment_context"
  117. deleted="false"
  118. description="Comment for fields"
  119. enabled="true"
  120. id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
  121. name="fieldcomment">
  122. /**
  123. * ${field}:${todo}（用一句话描述这个变量表示什么）
  124. *
  125. * @since Ver 1.1
  126. */
  127. </template>
  130. <template
  131. autoinsert="false"
  132. context="typecomment_context"
  133. deleted="false"
  134. description="Comment for created types"
  135. enabled="true"
  136. id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
  137. name="typecomment">
  138. /**
  139. * 此类描述的是：
  140. * @author: wangxiongdx@163.com
  141. * @version: ${date} ${time}
  142. */
  143. </template>
  145. </templates>

 

 

 

例子2：

 

[xhtml] view plaincopyprint?
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <templates>
  4. <template
  5. autoinsert="false"
  6. context="constructorcomment_context"
  7. deleted="false"
  8. description="Comment for created constructors"
  9. enabled="true"
  10. id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
  11. name="constructorcomment">
  12. /**
  13. * 创建一个新的实例 ${enclosing_type}.
  14. *
  15. * ${tags}
  16. */
  17. </template>
  19. <template
  20. autoinsert="true"
  21. context="settercomment_context"
  22. deleted="false"
  23. description="Comment for setter method"
  24. enabled="true"
  25. id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
  26. name="settercomment">
  27. /**
  28. * @param ${param} the ${bare_field_name} to set
  29. */
  30. </template>
  33. <template
  34. autoinsert="false"
  35. context="methodcomment_context"
  36. deleted="false"
  37. description="Comment for non-overriding methods"
  38. enabled="true"
  39. id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
  40. name="methodcomment">
  41. /**
  42. * 此方法描述的是：
  43. * @author: wangxiongdx@163.com
  44. * @version: ${date} ${time}
  45. */
  46. </template>
  49. <template
  50. autoinsert="true"
  51. context="delegatecomment_context"
  52. deleted="false"
  53. description="Comment for delegate methods"
  54. enabled="true"
  55. id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
  56. name="delegatecomment">
  57. /**
  58. * ${tags}
  59. * ${see_to_target}
  60. */
  61. </template>
  64. <template
  65. autoinsert="false"
  66. context="filecomment_context"
  67. deleted="false"
  68. description="Comment for created Java files"
  69. enabled="true"
  70. id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
  71. name="filecomment">
  72. /**
  73. * 文件名：${file_name}
  74. *
  75. * 版本信息：
  76. * 日期：${date}
  77. * Copyright 足下 Corporation ${year}
  78. * 版权所有
  79. *
  80. */
  81. </template>
  84. <template
  85. autoinsert="false"
  86. context="gettercomment_context"
  87. deleted="false"
  88. description="Comment for getter method"
  89. enabled="true"
  90. id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
  91. name="gettercomment">
  92. /**
  93. * ${bare_field_name}
  94. *
  95. * @return the ${bare_field_name}
  96. * @since CodingExample Ver(编码范例查看) 1.0
  97. */
  98. </template>
  100. <template
  101. autoinsert="true"
  102. context="overridecomment_context"
  103. deleted="false"
  104. description="Comment for overriding methods"
  105. enabled="true"
  106. id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
  107. name="overridecomment">
  108. /* (non-Javadoc)
  109. * ${see_to_overridden}
  110. */
  111. </template>
  114. <template
  115. autoinsert="false"
  116. context="fieldcomment_context"
  117. deleted="false"
  118. description="Comment for fields"
  119. enabled="true"
  120. id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
  121. name="fieldcomment">
  122. /**
  123. * ${field}:${todo}（用一句话描述这个变量表示什么）
  124. *
  125. * @since Ver 1.1
  126. */
  127. </template>
  130. <template
  131. autoinsert="false"
  132. context="typecomment_context"
  133. deleted="false"
  134. description="Comment for created types"
  135. enabled="true"
  136. id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
  137. name="typecomment">
  138. /**
  139. * 此类描述的是：
  140. * @author: wangxiongdx@163.com
  141. * @version: ${date} ${time}
  142. */
  143. </template>
  145. </templates>

 

分享到：
| UML解惑：图说UML中的六大关系(转)
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    Eclipse注释模板和格式化模板.zip

    本资料包“Eclipse注释模板和格式化模板.zip”包含了配置这两个功能所需的文件。 首先，我们来看看`codeFormatter.xml`文件。这个文件存储了Eclipse的代码格式化规则。通过定制这些规则，你可以使你的代码遵循特定...

    eclipse注释模板.xml

    eclipse注释模板

    eclipse注释模板文件

    eclipse注释模板文件

    Eclipse注释模板自定义

    一、Eclipse注释模板自定义 1. **打开Eclipse注释模板设置** 要自定义注释模板，首先需要进入Eclipse的首选项设置。点击菜单栏上的“Window” -&gt; “Preferences”，然后在弹出的对话框中依次选择“Java” -&gt; ...

    eclipse注释模板

    代码格式化和代码注释规范，导入eclipse中，一般在类和方法上都必须加通用文档注释，说明类和方法的作用，在特殊字段加相应注释，在复杂代码逻辑加相应行内注释说明代码逻辑。

    公司用的eclipse注释模板codetemplates

    公司用的eclipse注释模板codetemplates，经过多次升级最终版本

    eclipse 注释模板.xml

    eclipse 注释模板.xml

    eclipse注释模板xml文件

    在Eclipse中，开发者可以通过自定义注释模板来快速插入预先定义好的注释结构，这对于代码规范和团队协作非常有帮助。这些自定义模板通常存储在一个XML文件中，使得它们可以被共享、导入和导出。 在Eclipse中，注释...

    Eclipse 代码注释模板

    在Eclipse中，用户可以自定义代码注释模板，这通常涉及到类、方法、变量等不同类型的注释结构。`codetemplates.xml`文件就是存储这些自定义模板的配置文件，通过编辑这个文件，我们可以定制符合个人或团队编码规范的...

    eclipse注释模板及导入

    ### Eclipse注释模板详解与导入方法 在软件开发过程中，良好的代码注释习惯不仅能够提升代码的可读性，还能方便后期的维护和重构。Eclipse作为一款广泛使用的集成开发环境（IDE），提供了丰富的功能来支持开发者的...

    Eclipse Java 注释模板

    Eclipse作为一款强大的Java集成开发环境（IDE），提供了许多便捷的功能，其中之一就是“Eclipse Java 注释模板”。通过配置和使用这些模板，程序员可以快速地为代码添加注释，提高代码的可读性和维护性。下面我们将...

    eclipse注释模板.xml + 修改模板方法 + 使用方法

    一、Eclipse注释模板 Eclipse的注释模板允许程序员快速插入预定义的注释结构，例如类、方法或变量的注释，而无需手动输入每一行。这不仅节省时间，而且有助于保持团队间的一致性和代码文档的完整性。注释模板是通过...

    Myeclipse/eclipse注释模板一键导入配置

    总结来说，"Myeclipse/eclipse注释模板一键导入配置"是提高开发效率的重要手段，通过导入"配置myeclipse注释模板.txt"和"codetemplates.xml"文件，可以快速地定制和统一团队的代码注释风格，使得代码更易于理解和...

    Eclipse 注释模板

    华为风格 Eclipse 注释模板

    Eclipse Java注释模板.txt

    ### Eclipse Java注释模板知识点详解 #### 一、概述 在进行Java开发的过程中，良好的代码注释习惯不仅能帮助自己快速回顾代码逻辑，还能方便其他开发者理解代码意图，从而提高整个团队的工作效率。Eclipse作为一款...

    eclipse注释模板codetemplates.xml

    自己定义的注释模板，还算比较好用。用法是直接下载文件，在eclipse或myeclipse里面导入（preferences -- code templates -- comments -- import），使用的快捷键是 alt+shift+j，注释就自动加好了。

    eclipse/Myeclipse注释模板

    本文将详细介绍如何在 Eclipse 和 MyEclipse 中设置和使用注释模板，以及如何导入和配置提供的 "eclipse注释模板"。 1. **Eclipse 和 MyEclipse 注释模板** Eclipse 和 MyEclipse 都允许用户创建和管理自己的代码...

Magicbox
Global site tag (gtag.js) - Google Analytics