Eclipse中添加文档注释快捷键 - 1130136248

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，可以直接导入使用。贴出源码供大家参考一下

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <templates>  
3.   
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>  
16.   
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>  
27.   
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. /**  
35. * ${enclosing_method}(这里用一句话描述这个方法的作用)  
36. * TODO(这里描述这个方法适用条件 – 可选)  
37. * TODO(这里描述这个方法的执行流程 – 可选)  
38. * TODO(这里描述这个方法的使用方法 – 可选)  
39. * TODO(这里描述这个方法的注意事项 – 可选)  
40. * @param name  
41. * @param @return 设定文件  
42. * @return String DOM对象  
43. * @Exception 异常对象  
44. * @since  CodingExample　Ver(编码范例查看) 1.1  
45. */  
46. </template>  
47.   
48. <template autoinsert="true"  
49.                  context="delegatecomment_context"  
50.                  deleted="false"  
51.                  description="Comment for delegate methods"  
52.                  enabled="true"  
53.                  id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"  
54.                  name="delegatecomment">  
55. /**  
56. * ${tags}  
57. * ${see_to_target}  
58. */  
59. </template>  
60.   
61. <template autoinsert="false"  
62.                  context="filecomment_context"  
63.                  deleted="false"  
64.                  description="Comment for created Java files"  
65.                  enabled="true"  
66.                  id="org.eclipse.jdt.ui.text.codetemplates.filecomment"  
67.                  name="filecomment">  
68. /**  
69. * 文件名：${file_name}  
70. *  
71. * 版本信息：  
72. * 日期：${date}  
73. * Copyright 足下 Corporation ${year}  
74. * 版权所有  
75. *  
76. */  
77. </template>  
78.   
79. <template autoinsert="false"  
80.                  context="gettercomment_context"  
81.                  deleted="false"  
82.                  description="Comment for getter method"  
83.                  enabled="true"  
84.                  id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"  
85.                  name="gettercomment">  
86. /**  
87. * ${bare_field_name}  
88. *  
89. * @return  the ${bare_field_name}  
90. * @since   CodingExample Ver(编码范例查看) 1.0  
91. */  
92. </template>  
93.   
94. <template autoinsert="true"  
95.                  context="overridecomment_context"  
96.                  deleted="false"  
97.                  description="Comment for overriding methods"  
98.                  enabled="true"  
99.                  id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"  
100.                  name="overridecomment">  
101. /**  
102. * (non-Javadoc)  
103. * ${see_to_overridden}  
104. */  
105. </template>  
106.   
107. <template autoinsert="false"  
108.                  context="fieldcomment_context"  
109.                  deleted="false"  
110.                  description="Comment for fields"  
111.                  enabled="true"  
112.                  id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"  
113.                  name="fieldcomment">  
114. /**  
115. * ${field}:${todo}（用一句话描述这个变量表示什么）  
116. *  
117. * @since Ver 1.1  
118. */  
119. </template>  
120.   
121. <template autoinsert="false"  
122.                  context="typecomment_context"  
123.                  deleted="false"  
124.                  description="Comment for created types"  
125.                  enabled="true"  
126.                  id="org.eclipse.jdt.ui.text.codetemplates.typecomment"  
127.                  name="typecomment">  
128. /**  
129. *  
130. * 项目名称：${project_name}  
131. * 类名称：${type_name}  
132. * 类描述：  
133. * 创建人：${user}  
134. * 创建时间：${date} ${time}  
135. * 修改人：${user}  
136. * 修改时间：${date} ${time}  
137. * 修改备注：  
138. * @version  
139. *  
140. */</template>  
141.   
142. </templates>