Eclipse Java代码注释模板的设置

俗话说，工欲善其事，必先利其器。

eclipse作为一种非常重要的IDE，也是非常重要的。日程工作中，我们可以使用对其进行改造，让它更方便，提高我们工作的效率。Java模板注释就是很重要的。

1. eclipse用户名的设置：

在eclipse的安装路径下，打开eclipse.ini的配置文件：

[plain] view plain copy

1. -startup  
2. plugins/org.eclipse.equinox.launcher_1.2.0.v20110502.jar  
3. --launcher.library  
4. plugins/org.eclipse.equinox.launcher.win32.win32.x86_1.1.100.v20110502  
5. -product  
6. org.eclipse.epp.package.java.product  
7. --launcher.defaultAction  
8. openFile  
9. --launcher.XXMaxPermSize  
10. 256M  
11. -showsplash  
12. org.eclipse.platform  
13. --launcher.XXMaxPermSize  
14. 256m  
15. --launcher.defaultAction  
16. openFile  
17. -vmargs  
18. -Duser.name=xxx  
19. -Dosgi.requiredJavaVersion=1.5  
20. -Xms40m  
21. -Xmx384m  

在-vmargs下加入：

-Duser.name=你的名字

2. 注释模板的设置

我们打开

Window->Preference->Java->Code Style->Code Template 

然后展开Comments节点就是所有需设置注释的元素啦。

2.1 注释格式以及各个主要简介

1. 单行(single-line)注释：“//……”
2. 块(block)注释：“/*……*/”
3. 文档注释：“/**……*/”
4. javadoc注释标签语法

@author   对类的说明标明开发该类模块的作者
@version   对类的说明标明该类模块的版本
@see    对类、属性、方法的说明参考转向，也就是相关主题
@param    对方法的说明对方法中某参数的说明
@return   对方法的说明对方法返回值的说明
@exception  对方法的说明对方法可能抛出的异常进行说明

@return_type返回类型

@date 日期

@time时间

2.2 注释元素说明

• 文件(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}
*/

3. 几个注释模板

模板1：

[html] view plain copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <templates>  
3. <template   
4.     autoinsert="true"   
5.     context="fieldcomment_context"   
6.     deleted="false"   
7.     description="字段的注释"   
8.     enabled="true"   
9.     id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"   
10.     name="fieldcomment">  
11. /**  
12. * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)  
13. */  
14.   
15. </template>  
16. <template   
17.     autoinsert="true"   
18.     context="gettercomment_context"   
19.     deleted="false"   
20.     description="getter 方法的注释"   
21.     enabled="true"   
22.     id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"   
23.     name="gettercomment">  
24. /**  
25.  * @return ${bare_field_name}  
26.  */  
27. </template>  
28. <template   
29.     autoinsert="true"   
30.     context="constructorcomment_context"   
31.     deleted="false"   
32.     description="创建的构造函数的注释"   
33.     enabled="true"   
34.     id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"   
35.     name="constructorcomment">  
36. /**  
37. * <p>Title:${file_name} </p>  
38. * <p>Description: 构造函数</p>  
39. * ${tags}  
40. */  
41.   
42. </template>  
43. <template   
44.     autoinsert="true"   
45.     context="filecomment_context"   
46.     deleted="false"   
47.     description="已创建的 Java 文件的注释"   
48.     enabled="true"   
49.     id="org.eclipse.jdt.ui.text.codetemplates.filecomment"   
50.     name="filecomment">  
51. /**    
52. * @Title: ${file_name}  
53. * @Package ${package_name}  
54. * @Description: ${todo}(用一句话描述该文件做什么)  
55. * @author long.luo  
56. * @date ${date} ${time}  
57. * @version V1.0    
58. */  
59.   
60.  </template>  
61.  <template   
62.     autoinsert="true"   
63.     context="settercomment_context"   
64.     deleted="false"   
65.     description="setter 方法的注释"   
66.     enabled="true"   
67.     id="org.eclipse.jdt.ui.text.codetemplates.settercomment"   
68.     name="settercomment">  
69. /**  
70.  * @param ${param} 要设置的 ${bare_field_name}  
71.  */  
72.    
73.  </template>  
74.  <template   
75.     autoinsert="true"   
76.     context="typecomment_context"   
77.     deleted="false"   
78.     description="创建的类型的注释"   
79.     enabled="true"   
80.     id="org.eclipse.jdt.ui.text.codetemplates.typecomment"   
81.     name="typecomment">  
82. /**  
83.  * @author ${user}  
84.  *  
85.  * ${tags}  
86.  */  
87.    
88.  </template>  
89.    
90.  <template   
91.     autoinsert="true"   
92.     context="delegatecomment_context"   
93.     deleted="false"   
94.     description="代表方法的注释"   
95.     enabled="true"   
96.     id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"   
97.     name="delegatecomment">  
98. /**  
99. * ${tags}  
100. * ${see_to_target}  
101. */  
102.   
103. </template>  
104. <template   
105.     autoinsert="true"   
106.     context="overridecomment_context"   
107.     deleted="false"   
108.     description="覆盖方法的注释"   
109.     enabled="true"   
110.     id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"   
111.     name="overridecomment">  
112. /** (非 Javadoc)  
113. * <p>Title: ${enclosing_method}</p>  
114. * <p>Description: </p>  
115. * ${tags}  
116. * ${see_to_overridden}  
117. */  
118.   
119. </template>  
120. <template   
121.     autoinsert="true"   
122.     context="methodcomment_context"   
123.     deleted="false"   
124.     description="非覆盖方法的注释"   
125.     enabled="true"   
126.     id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"   
127.     name="methodcomment">  
128. /**  
129.  * ${tags}  
130.  */  
131.    
132. </template>  
133. </templates>  

模板2：

[html] view plain copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <templates>  
3.       
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>  
18.       
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>  
31.       
32.       
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: [e-mail]  
44.      * @version: ${date} ${time}  
45.      */  
46.     </template>  
47.       
48.       
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>  
62.       
63.       
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>  
82.       
83.       
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>  
99.   
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>  
112.       
113.       
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>  
128.       
129.       
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: [e-mail]  
141.      * @version: ${date} ${time}   
142.      */  
143.     </template>  
144.    
145.  </templates>  

以上请知悉！