Eclipse：平添文档注释快捷键 修改快捷键及模板

Eclipse：添加文档注释快捷键 修改快捷键及模板

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

?

1. <?xml?version="1.0"?encoding="UTF-8"?>??<templates>??
2. ??<template?autoinsert="false"??
3. ?????????????????context="constructorcomment_context"???????????????????deleted="false"?description="Comment?for?created?constructors"??
4. ?????????????????enabled="true"???????????????????id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"??
5. ?????????????????name="constructorcomment">???/**????
6. *?创建一个新的实例?${enclosing_type}.????*????
7. *?${tags}????*/??
8. </template>????
9. <template?autoinsert="true"???????????????????context="settercomment_context"??
10. ?????????????????deleted="false"???????????????????description="Comment?for?setter?method"??
11. ?????????????????enabled="true"?id="org.eclipse.jdt.ui.text.codetemplates.settercomment"???????????????????name="settercomment">??
12. /**????*?@param?${param}?the?${bare_field_name}?to?set????
13. */??</template>??
14. ??<template?autoinsert="false"??
15. ?????????????????context="methodcomment_context"???????????????????deleted="false"??
16. ?????????????????description="Comment?for?non-overriding?methods"???????????????????enabled="true"?id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"??
17. ?????????????????name="methodcomment">??/**????
18. ???*?${enclosing_method}(这里用一句话描述这个方法的作用)????
19. ???*?TODO(这里描述这个方法适用条件?–?可选)????
20. ???*?TODO(这里描述这个方法的执行流程?–?可选)????
21. ???*?TODO(这里描述这个方法的使用方法?–?可选)????
22. ???*?TODO(这里描述这个方法的注意事项?–?可选)????
23. ???*?@param???name????
24. ???*?@param??@return????设定文件????
25. ???*?@return?String????DOM对象????
26. ???*?@Exception?异常对象????
27. ???*?@since??CodingExample　Ver(编码范例查看)?1.1????
28. ???*/??
29. </template>????
30. <template?autoinsert="true"???????????????????context="delegatecomment_context"??
31. ?????????????????deleted="false"???????????????????description="Comment?for?delegate?methods"??
32. ?????????????????enabled="true"???????????????????id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"??
33. ?????????????????name="delegatecomment">??/**????
34. *?${tags}????*?${see_to_target}????
35. */??</template>??
36. ??<template?autoinsert="false"??
37. ?????????????????context="filecomment_context"???????????????????deleted="false"??
38. ?????????????????description="Comment?for?created?Java?files"???????????????????enabled="true"??
39. ?????????????????id="org.eclipse.jdt.ui.text.codetemplates.filecomment"???????????????????name="filecomment">??
40. /**????*?文件名：${file_name}????
41. *????*?版本信息：????
42. *?日期：${date}????*?Copyright?足下?Corporation?${year}?????
43. *?版权所有????*????
44. */??</template>??
45. ??<template?autoinsert="false"??
46. ?????????????????context="gettercomment_context"???????????????????deleted="false"??
47. ?????????????????description="Comment?for?getter?method"???????????????????enabled="true"??
48. ?????????????????id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"???????????????????name="gettercomment">??
49. /**????*?${bare_field_name}????
50. *????*?@return??the?${bare_field_name}????
51. *?@since???CodingExample?Ver(编码范例查看)?1.0????*/????
52. </template>????
53. <template?autoinsert="true"???????????????????context="overridecomment_context"??
54. ?????????????????deleted="false"???????????????????description="Comment?for?overriding?methods"??
55. ?????????????????enabled="true"???????????????????id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"??
56. ?????????????????name="overridecomment">??/**??
57. *?(non-Javadoc)????*?${see_to_overridden}????
58. */??</template>??
59. ??<template?autoinsert="false"??
60. ?????????????????context="fieldcomment_context"???????????????????deleted="false"??
61. ?????????????????description="Comment?for?fields"???????????????????enabled="true"??
62. ?????????????????id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"???????????????????name="fieldcomment">??
63. /**????*?${field}:${todo}（用一句话描述这个变量表示什么）????
64. *????*?@since?Ver?1.1????
65. */????</template>??
66. ??<template?autoinsert="false"??
67. ?????????????????context="typecomment_context"???????????????????deleted="false"??
68. ?????????????????description="Comment?for?created?types"???????????????????enabled="true"??
69. ?????????????????id="org.eclipse.jdt.ui.text.codetemplates.typecomment"???????????????????name="typecomment">??
70. /**????*?????
71. *?项目名称：${project_name}????*?类名称：${type_name}????
72. *?类描述：????*?创建人：${user}????
73. *?创建时间：${date}?${time}????*?修改人：${user}????
74. *?修改时间：${date}?${time}????*?修改备注：????
75. *?@version?????*?????
76. */</template>????
77. </templates>??