Eclipse中添加文档注释快捷键

例如：

/**
* @param
* @return

*/

快捷键为：ALT + SHIFT +J

想更换为其他的快捷键：

Window-->Preferences-->General-->Keys;找到"add javadoc comment"更改自己喜欢的快捷键。

另外如果觉得注释也不爽时也可以改改，修改的方法有两种：

1.直接在eclipse给的模板下进行修改

2.自己编写一个xml文档导入进去

那就来先说说第一种方法吧：

打开eclipse

Window-->Preferences-->Java-->Code Style --> Code Templates --> Comments --> types --> Edit

/**
*
* 项目名称：${project_name}
* 类名称：${type_name}
* 类描述：
* 创建人：${user}
* 创建时间：${date} ${time}
* 修改人：${user}
* 修改时间：${date} ${time}
* 修改备注：
* @version
*
*/

第二种方法是：

点击右边的import按钮选择你写好的模板.xml文件

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

[xhtml] view plain copy print ?

1. <?xml version="1.0" encoding="UTF-8"?>
2. <templates>
4. <template autoinsert="false"
5. context="constructorcomment_context"
6. deleted="false" description="Comment for created constructors"
7. enabled="true"
8. id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
9. name="constructorcomment">
10. /**
11. * 创建一个新的实例 ${enclosing_type}.
12. *
13. * ${tags}
14. */
15. </template>
17. <template autoinsert="true"
18. context="settercomment_context"
19. deleted="false"
20. description="Comment for setter method"
21. enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
22. name="settercomment">
23. /**
24. * @param ${param} the ${bare_field_name} to set
25. */
26. </template>
28. <template autoinsert="false"
29. context="methodcomment_context"
30. deleted="false"
31. description="Comment for non-overriding methods"
32. enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
33. name="methodcomment">
34. /**
36. * ${enclosing_method}(这里用一句话描述这个方法的作用)
38. * TODO(这里描述这个方法适用条件 – 可选)
40. * TODO(这里描述这个方法的执行流程 – 可选)
42. * TODO(这里描述这个方法的使用方法 – 可选)
44. * TODO(这里描述这个方法的注意事项 – 可选)
46. * @param name
48. * @param @return 设定文件
50. * @return String DOM对象
52. * @Exception 异常对象
54. * @since CodingExample　Ver(编码范例查看) 1.1
56. */
57. </template>
59. <template autoinsert="true"
60. context="delegatecomment_context"
61. deleted="false"
62. description="Comment for delegate methods"
63. enabled="true"
64. id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
65. name="delegatecomment">
66. /**
67. * ${tags}
68. * ${see_to_target}
69. */
70. </template>
72. <template autoinsert="false"
73. context="filecomment_context"
74. deleted="false"
75. description="Comment for created Java files"
76. enabled="true"
77. id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
78. name="filecomment">
79. /**
80. * 文件名：${file_name}
81. *
82. * 版本信息：
83. * 日期：${date}
84. * Copyright 足下 Corporation ${year}
85. * 版权所有
86. *
87. */
88. </template>
90. <template autoinsert="false"
91. context="gettercomment_context"
92. deleted="false"
93. description="Comment for getter method"
94. enabled="true"
95. id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
96. name="gettercomment">
97. /**
98. * ${bare_field_name}
99. *
100. * @return the ${bare_field_name}
101. * @since CodingExample Ver(编码范例查看) 1.0
102. */
103. </template>
105. <template autoinsert="true"
106. context="overridecomment_context"
107. deleted="false"
108. description="Comment for overriding methods"
109. enabled="true"
110. id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
111. name="overridecomment">
112. /**
113. * (non-Javadoc)
114. * ${see_to_overridden}
115. */
116. </template>
118. <template autoinsert="false"
119. context="fieldcomment_context"
120. deleted="false"
121. description="Comment for fields"
122. enabled="true"
123. id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
124. name="fieldcomment">
125. /**
126. * ${field}:${todo}（用一句话描述这个变量表示什么）
127. *
128. * @since Ver 1.1
129. */
130. </template>
132. <template autoinsert="false"
133. context="typecomment_context"
134. deleted="false"
135. description="Comment for created types"
136. enabled="true"
137. id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
138. name="typecomment">
139. /**
140. *
141. * 项目名称：${project_name}
142. * 类名称：${type_name}
143. * 类描述：
144. * 创建人：${user}
145. * 创建时间：${date} ${time}
146. * 修改人：${user}
147. * 修改时间：${date} ${time}
148. * 修改备注：
149. * @version
150. *
151. */</template>
153. </templates>

<?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"> /** * 创建一个新的实例 ${enclosing_type}. * * ${tags} */ </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"> /** * @param ${param} the ${bare_field_name} to set */ </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"> /** * ${enclosing_method}(这里用一句话描述这个方法的作用) * TODO(这里描述这个方法适用条件 – 可选) * TODO(这里描述这个方法的执行流程 – 可选) * TODO(这里描述这个方法的使用方法 – 可选) * TODO(这里描述这个方法的注意事项 – 可选) * @param name * @param @return 设定文件 * @return String DOM对象 * @Exception 异常对象 * @since CodingExample　Ver(编码范例查看) 1.1 */ </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"> /** * ${tags} * ${see_to_target} */ </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"> /** * 文件名：${file_name} * * 版本信息： * 日期：${date} * Copyright 足下 Corporation ${year} * 版权所有 * */ </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"> /** * ${bare_field_name} * * @return the ${bare_field_name} * @since CodingExample Ver(编码范例查看) 1.0 */ </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) * ${see_to_overridden} */ </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"> /** * ${field}:${todo}（用一句话描述这个变量表示什么） * * @since Ver 1.1 */ </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"> /** * * 项目名称：${project_name} * 类名称：${type_name} * 类描述： * 创建人：${user} * 创建时间：${date} ${time} * 修改人：${user} * 修改时间：${date} ${time} * 修改备注： * @version * */</template> </templates>

参考文章：http://www.javaeye.com/topic/585168