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}(用一句话描述这个变量表示什么)
*/
构造函数标签:

/**
*

Title:


*

Description:


* ${tags}
*/


方法(Constructor & Methods)标签:

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


覆盖方法(Overriding Methods)标签:

/* (非 Javadoc)
*

Title: ${enclosing_method}


*

Description:


* ${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}(用一句话描述这个变量表示什么)
*/
构造函数标签:

/**
*

Title:


*

Description:


* ${tags}
*/


方法(Constructor & Methods)标签:

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


覆盖方法(Overriding Methods)标签:

/* (非 Javadoc)
*

Title: ${enclosing_method}


*

Description:


* ${tags}
* ${see_to_overridden}
*/


代表方法(Delegate Methods)标签:

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

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

setter方法标签:

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

 

简单模板例子:

 

[java] view plain copy print ?
  1. "1.0" encoding="UTF-8"?>

 

 

 

例子2:

 

[xhtml] view plain copy print ?
  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: [email protected]
  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: [email protected]
  126. * @version: ${date} ${time}
  127. */
  128. template>
  129. templates>

 

 

 

例子2:

 

[xhtml] view plain copy print ?
  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: [email protected]
  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: [email protected]
  126. * @version: ${date} ${time}
  127. */
  128. template>
  129. templates>

 

你可能感兴趣的:(eclipse,模板,注释,eclipse注释模板)