1.设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。
2.Window->Preference->Java->Code Style->Code Template 然后可以选择import导入外部的注释模板和导出自己的注释模板
文件(Files)注释标签：
|
1
2
3
4
5
6
7
8
|
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author ${user}
* @date ${date}
* @version V1.0
*/
|
类型(Types)注释标签（类的注释）：
|
1
2
3
4
5
6
7
8
|
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author ${user}
* @date ${date}
*
* ${tags}
*/
|
字段(Fields)注释标签：
|
1
2
3
|
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
|
构造函数(Constructor)标签：
|
1
2
3
4
5
|
/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/
|
方法(Methods)标签：
|
1
2
3
4
5
6
7
|
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 参数
* @return ${return_type} 返回类型
* @throws
*/
|
覆盖方法(Overriding Methods)标签：
|
1
2
3
4
5
6
|
/* (非 Javadoc)
*
Title: ${enclosing_method}
*
Description:
* ${tags}
* ${see_to_overridden}
*/
|
代理方法(Delegate Methods)标签：
|
1
2
3
4
|
/**
* ${tags}
* ${see_to_target}
*/
|
getter方法标签：
|
1
2
3
|
/**
* @return ${bare_field_name}
*/
|
setter方法标签：
|
1
2
3
|
/**
* @param ${param} the ${bare_field_name} to set
*/
|
要实现上面的注释模板，这需要将下面的配置文件导入就可以了：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
xml
version
=
"1.0"
encoding
=
"UTF-8"
?>
<
templates
>
<
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"
>
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author ${user}
* @date ${date}
* @version V1.0
*/
<
/
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"
>
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author ${user}
* @date ${date}
*
* ${tags}
*/
<
/
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"
>
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
<
/
template
>
<
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
=
"false"
context
=
"methodcomment_context"
deleted
=
"false"
description
=
"Comment for non-overriding methods"
enabled
=
"true"
id
=
"org.eclipse.jdt.ui.text.codetemplates.methodcomment"
name
=
"methodcomment"
>
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 参数
* @return ${return_type} 返回类型
* @throws
*/
<
/
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"
>
/* (非 Javadoc)
*
Title: ${enclosing_method}
*
Description:
* ${tags}
* ${see_to_overridden}
*/
<
/
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
=
"gettercomment_context"
deleted
=
"false"
description
=
"Comment for getter method"
enabled
=
"true"
id
=
"org.eclipse.jdt.ui.text.codetemplates.gettercomment"
name
=
"gettercomment"
>
/**
* @return ${bare_field_name}
*/
<
/
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
>
<
/
templates
>
|
该博客转至:http://swiftlet.net/archives/1199