Eclipse注释模板设置详解

末蓝、 2022-05-24 21:18 234阅读 0赞

原文出处：https://blog.csdn.net/paul342/article/details/52982585

设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。本文现就每一个元素逐一给大家介绍一下。

文件(Files)注释标签：

\[html\]  [view plain][]   [copy][view plain]

1.  /\*\*  
2.  \* @Title: $\{file\_name\}  
3.  \* @Package $\{package\_name\}  
4.  \* @Description: $\{todo\}(用一句话描述该文件做什么)  
5.  \* @author $\{user\}  
6.  \* @date $\{date\}  
7.  \* @version V1.0  
8.  \*/

类型(Types)注释标签（类的注释）：

\[html\]  [view plain][]   [copy][view plain]

1.  /\*\*  
2.  \* @ClassName: $\{type\_name\}  
3.  \* @Description: $\{todo\}(这里用一句话描述这个类的作用)  
4.  \* @author $\{user\}  
5.  \* @date $\{date\}  
6.  \*  
7.  \* $\{tags\}  
8.  \*/

字段(Fields)注释标签：

\[html\]  [view plain][]   [copy][view plain]

1.  /\*\*  
2.  \* @Fields field:field:\{todo\}(用一句话描述这个变量表示什么)  
3.  \*/

构造函数(Constructor)标签：

\[html\]  [view plain][]   [copy][view plain]

1.  /\*\*  
2.  \* 创建一个新的实例 $\{enclosing\_type\}.  
3.  \*  
4.  \* $\{tags\}  
5.  \*/

方法(Methods)标签：

\[html\]  [view plain][]   [copy][view plain]

1.  /\*\*  
2.  \* @Title: $\{enclosing\_method\}  
3.  \* @Description: $\{todo\}(这里用一句话描述这个方法的作用)  
4.  \* @param $\{tags\}    参数  
5.  \* @return $\{return\_type\}    返回类型  
6.  \* @throws  
7.  \*/

覆盖方法(Overriding Methods)标签：

\[html\]  [view plain][]   [copy][view plain]

1.  /\* (非 Javadoc)  
2.  \* **<****p****>**Title: $\{enclosing\_method\}**</****p****>**  
3.  \* **<****p****>**Description: **</****p****>**  
4.  \* $\{tags\}  
5.  \* $\{see\_to\_overridden\}  
6.  \*/

代理方法(Delegate Methods)标签：

\[html\]  [view plain][]   [copy][view plain]

1.  /\*\*  
2.  \* $\{tags\}  
3.  \* $\{see\_to\_target\}  
4.  \*/

getter方法标签：

\[html\]  [view plain][]   [copy][view plain]

1.  /\*\*  
2.  \* @return $\{bare\_field\_name\}  
3.  \*/

setter方法标签：

\[html\]  [view plain][]   [copy][view plain]

1.  /\*\*  
2.  \* @param paramtheparamthe\{bare\_field\_name\} to set  
3.  \*/

要实现上面的注释模板，这需要将下面的配置文件导入就可以了：

\[html\]  [view plain][]   [copy][view plain]

1.  **<?****xml** version="1.0" encoding="UTF-8"**?>**  
2.  **<****templates****>**  
3.      **<****template**  
4.                  autoinsert="false"  
5.                  context="filecomment\_context"  
6.                  deleted="false"  
7.                  description="Comment for created Java files"  
8.                  enabled="true"  
9.                  id="org.eclipse.jdt.ui.text.codetemplates.filecomment"  
10.                 name="filecomment"**>**  
11.     /\*\*    
12.     \* @Title: $\{file\_name\}  
13.     \* @Package $\{package\_name\}  
14.     \* @Description: $\{todo\}(用一句话描述该文件做什么)  
15.     \* @author $\{user\}  
16.     \* @date $\{date\}  
17.     \* @version V1.0    
18.     \*/  
19.     **</****template****>**  
20.     **<****template**  
21.                 autoinsert="false"  
22.                 context="typecomment\_context"  
23.                 deleted="false"  
24.                 description="Comment for created types"  
25.                 enabled="true"  
26.                 id="org.eclipse.jdt.ui.text.codetemplates.typecomment"  
27.                 name="typecomment"**>**  
28.     /\*\*  
29.     \* @ClassName: $\{type\_name\}  
30.     \* @Description: $\{todo\}(这里用一句话描述这个类的作用)  
31.     \* @author $\{user\}  
32.     \* @date $\{date\}  
33.     \*  
34.     \* $\{tags\}  
35.     \*/  
36.     **</****template****>**  
37.     **<****template**  
38.                 autoinsert="false"  
39.                 context="fieldcomment\_context"  
40.                 deleted="false"  
41.                 description="Comment for fields"  
42.                 enabled="true"  
43.                 id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"  
44.                 name="fieldcomment"**>**  
45.     /\*\*  
46.     \* @Fields field:field:\{todo\}(用一句话描述这个变量表示什么)  
47.     \*/  
48.     **</****template****>**  
49.     **<****template**  
50.                 autoinsert="false"  
51.                   context="constructorcomment\_context"  
52.                 deleted="false"  
53.                 description="Comment for created constructors"  
54.                 enabled="true"  
55.                 id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"  
56.                 name="constructorcomment"**>**  
57.     /\*\*  
58.      \* 创建一个新的实例 $\{enclosing\_type\}.  
59.      \*  
60.      \* $\{tags\}  
61.      \*/  
62.     **</****template****>**  
63.         **<****template**  
64.                 autoinsert="false"  
65.                 context="methodcomment\_context"  
66.                 deleted="false"  
67.                 description="Comment for non-overriding methods"  
68.                 enabled="true"  
69.                 id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"  
70.                 name="methodcomment"**>**  
71.     /\*\*  
72.     \* @Title: $\{enclosing\_method\}  
73.     \* @Description: $\{todo\}(这里用一句话描述这个方法的作用)  
74.     \* @param $\{tags\}    参数  
75.     \* @return $\{return\_type\}    返回类型  
76.     \* @throws  
77.     \*/  
78.     **</****template****>**  
79.     **<****template**  
80.                 autoinsert="true"  
81.                 context="overridecomment\_context"  
82.                 deleted="false"  
83.                 description="Comment for overriding methods"  
84.                 enabled="true"  
85.                 id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"  
86.                 name="overridecomment"**>**  
87.     /\* (非 Javadoc)  
88.     \* **<****p****>**Title: $\{enclosing\_method\}**</****p****>**  
89.     \* **<****p****>**Description: **</****p****>**  
90.     \* $\{tags\}  
91.     \* $\{see\_to\_overridden\}  
92.     \*/  
93.     **</****template****>**  
94.         **<****template**  
95.                 autoinsert="true"  
96.                 context="delegatecomment\_context"  
97.                 deleted="false"  
98.                 description="Comment for delegate methods"  
99.                 enabled="true"  
100.                 id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"  
101.                 name="delegatecomment"**>**  
102.     /\*\*  
103.      \* $\{tags\}  
104.      \* $\{see\_to\_target\}  
105.      \*/  
106.     **</****template****>**  
107.     **<****template**  
108.                 autoinsert="false"  
109.                 context="gettercomment\_context"  
110.                 deleted="false"  
111.                 description="Comment for getter method"  
112.                 enabled="true"  
113.                 id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"  
114.                 name="gettercomment"**>**  
115.     /\*\*  
116.     \* @return $\{bare\_field\_name\}  
117.     \*/  
118.     **</****template****>**  
119.     **<****template**  
120.                 autoinsert="true"  
121.                 context="settercomment\_context"  
122.                 deleted="false"  
123.                 description="Comment for setter method"  
124.                 enabled="true"  
125.                 id="org.eclipse.jdt.ui.text.codetemplates.settercomment"  
126.                 name="settercomment"**>**  
127.     /\*\*  
128.      \* @param paramtheparamthe\{bare\_field\_name\} to set  
129.      \*/  
130.     **</****template****>**  
131. **</****templates****>**

[view plain]: https://blog.csdn.net/paul342/article/details/52982585#

发表评论取消回复

表情：

评论列表（有 0 条评论，234人围观）

还没有评论，来说两句吧...

相关阅读

相关 Eclipse注释模板设置详解

前言：上一篇文章[《Eclipse添加注释简介》][Eclipse]给大家简单介绍了一下在注释的相关设置，本文将会进一步讲解有关注释的内容。设置注释模板的入口：

青旅半醒/ 2022年07月16日 07:08/ 0 赞/ 217 阅读

相关 Eclipse注释模板设置详解

设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素

叁歲伎倆/ 2022年07月14日 02:10/ 0 赞/ 192 阅读

相关 Eclipse Java注释模板设置详解

设置注释模板的入口： Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元

叁歲伎倆/ 2022年07月12日 12:28/ 0 赞/ 156 阅读

相关 Eclipse Java注释模板设置详解

原文：[http://blog.csdn.net/ahhsxy/article/details/4542682][http_blog.csdn.net_ahhsxy_artic

喜欢ヅ旅行/ 2022年06月18日 12:43/ 0 赞/ 189 阅读

相关 Eclipse注释模板设置详解

Eclipse注释模板设置详解 [《Eclipse添加注释简介》][Eclipse]给大家简单介绍了一下在注释的相关设置，本文将会进一步讲解有关注释的内容。设置

淡淡的烟草味﹌/ 2022年06月16日 00:53/ 0 赞/ 231 阅读

相关 Eclipse Java注释模板设置详解

设置注释模板的入口： Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元

缺乏、安全感/ 2022年06月02日 05:25/ 0 赞/ 208 阅读

相关 Eclipse注释模板设置详解

原文出处：https://blog.csdn.net/paul342/article/details/52982585 设置注释模板的入口：Window->Preferenc

末蓝、/ 2022年05月24日 21:18/ 0 赞/ 235 阅读

相关 Eclipse注释模板设置详解

设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素

川长思鸟来/ 2022年05月24日 06:42/ 0 赞/ 210 阅读

相关 Eclipse工具---注释模板设置详解

设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素

蔚落/ 2022年05月23日 13:51/ 0 赞/ 207 阅读

相关 Eclipse Java注释模板设置详解

Eclipse Java注释模板设置详解网上的Eclipse注释模板，在这里稍稍整理一些比较常用的。编辑注释模板的方法：Window->Preference-

╰+哭是因爲堅強的太久メ/ 2022年05月20日 00:24/ 0 赞/ 249 阅读