java 注释模板

偏执的太偏执、 2022-07-12 06:46 226阅读 0赞

从工作开始，经历了几个项目的开发，现在的项目一般都是一个团队共同开发，而每个人都有自己的编码习惯，为了统一格式，项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置，但是在执行过程中往往发现效果不是很好（主要是指编码规范这一方面）。所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格。主要包括三个方面：设置Code Templates、Eclipse formatter、Checkstyle，本篇主要介绍如何设置Code Templates，具体步骤如下：

打开Window->Preferences->Java->Code Style->Code Templates

![Eclipse设置Code Templates][Eclipse_Code Templates]

点击"Import"，导入模板codetemplates.xml文件。

codetemplates.xml内容是我们自己预先定义好的，在这里先不详细描述，我们可以看到Eclipse Code Templates界面中间Configure generated code and comments区域包含了两个菜单树：Comment、Code，如下图所示：

![0a7cfe6a-7459-33e2-afec-3a6813628063.jpg][]

Comments代表注释模板，Code代表代码模板，其中每一个子菜单代表子项的模板。

我们只要点击某一个子项，就会在界面下方的Pattern区域看到该项我们所定义的模板内容和格式，如下图所示：

![d4b683f0-da94-3725-aa92-41ff42fd947d.jpg][]

如上图所示，当我们点击Comments下的Files子菜单时，下面的Pattern会显示Java文件的头部注释。

下面详细列出每一个子项的模板格式：

Comments-->Files（Java文件注释）

Java代码   ![收藏代码][icon_star.png]

1.  /\*\* 
2.   \* Project Name:$\{project\_name\} 
3.   \* File Name:$\{file\_name\} 
4.   \* Package Name:$\{package\_name\} 
5.   \* Date:$\{date\}$\{time\} 
6.   \* Copyright (c) $\{year\}, chenzhou1025@126.com All Rights Reserved. 
7.   \* 
8.   \*/

Comments-->Types（Java类注释）

Java代码   ![收藏代码][icon_star.png]

1.  /\*\* 
2.   \* ClassName: $\{type\_name\} <br/> 
3.   \* Function: $\{todo\} ADD FUNCTION. <br/> 
4.   \* Reason: $\{todo\} ADD REASON(可选). <br/> 
5.   \* date: $\{date\} $\{time\} <br/> 
6.   \* 
7.   \* @author $\{user\} 
8.   \* @version $\{enclosing\_type\}$\{tags\} 
9.   \* @since JDK 1.6 
10.  \*/

Comments-->Fields（类字段注释）

Java代码   ![收藏代码][icon_star.png]

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

Comments-->Constructors（构造函数注释）

Java代码   ![收藏代码][icon_star.png]

1.  /\*\* 
2.   \* Creates a new instance of $\{enclosing\_type\}. 
3.   \* 
4.   \* $\{tags\} 
5.   \*/

Comments-->Methods（Java方法注释）

Java代码   ![收藏代码][icon_star.png]

1.  /\*\* 
2.   \* $\{enclosing\_method\}:(这里用一句话描述这个方法的作用). <br/> 
3.   \* $\{todo\}(这里描述这个方法适用条件 – 可选).<br/> 
4.   \* $\{todo\}(这里描述这个方法的执行流程 – 可选).<br/> 
5.   \* $\{todo\}(这里描述这个方法的使用方法 – 可选).<br/> 
6.   \* $\{todo\}(这里描述这个方法的注意事项 – 可选).<br/> 
7.   \* 
8.   \* @author $\{user\} 
9.   \* $\{tags\} 
10.  \* @since JDK 1.6 
11.  \*/

Comments-->Overriding methods（重写方法注释）

Java代码   ![收藏代码][icon_star.png]

1.  /\*\* 
2.   \* $\{todo\} 简单描述该方法的实现功能（可选）. 
3.   \* $\{see\_to\_overridden\} 
4.   \*/

Comments-->Delegate methods（代理方法注释）

Java代码   ![收藏代码][icon_star.png]

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

Comments-->Getters（Java Getter方法注释）

Java代码   ![收藏代码][icon_star.png]

1.  /\*\* 
2.   \* $\{bare\_field\_name\}. 
3.   \* 
4.   \* @return  the $\{bare\_field\_name\} 
5.   \* @since   JDK 1.6 
6.   \*/

Comments-->Setters（Java Setters方法注释）

Java代码   ![收藏代码][icon_star.png]

1.  /\*\* 
2.   \* $\{param\}. 
3.   \* 
4.   \* @param   $\{param\}    the $\{bare\_field\_name\} to set 
5.   \* @since   JDK 1.6 
6.   \*/

Code-->New Java files（新建java文件代码模板）

Java代码   ![收藏代码][icon_star.png]

1.  /\*\* 
2.   \* Project Name:$\{project\_name\} 
3.   \* File Name:$\{file\_name\} 
4.   \* Package Name:$\{package\_name\} 
5.   \* Date:$\{date\}$\{time\} 
6.   \* Copyright (c) $\{year\}, chenzhou1025@126.com All Rights Reserved. 
7.   \* 
8.  \*/  
9.  $\{filecomment\}  
10.   
11. $\{package\_declaration\}  
12. /\*\* 
13.  \* ClassName:$\{type\_name\} <br/> 
14.  \* Function: $\{todo\} ADD FUNCTION. <br/> 
15.  \* Reason:   $\{todo\} ADD REASON. <br/> 
16.  \* Date:     $\{date\} $\{time\} <br/> 
17.  \* @author   $\{user\} 
18.  \* @version   
19.  \* @since    JDK 1.6 
20.  \* @see       
21.  \*/  
22. $\{typecomment\}  
23. $\{type\_declaration\}

Code-->Method body（方法体模板）

Java代码   ![收藏代码][icon_star.png]

1.  // $\{todo\} Auto-generated method stub  
2.  $\{body\_statement\}

Code-->Constructor body（构造函数模板）

Java代码   ![收藏代码][icon_star.png]

1.  $\{body\_statement\}  
2.  // $\{todo\} Auto-generated constructor stub

Code-->Getter body（字段Getter方法模板）

Java代码   ![收藏代码][icon_star.png]

1.  **return** $\{field\};

Code-->Setter body（字段Setter方法模板）

Java代码   ![收藏代码][icon_star.png]

1.  $\{field\} = $\{param\};

Code-->Catch block body（异常catch代码块模板）

Java代码   ![收藏代码][icon_star.png]

1.  // $\{todo\} Auto-generated catch block  
2.  $\{exception\_var\}.printStackTrace();

其中codetemplates.xml内容如下：

Xml代码   ![收藏代码][icon_star.png]

1.  **<?****xml** version="1.0" encoding="UTF-8" standalone="no"**?>****<****templates****>****<****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"**>**/\*\*  
2.   \* $\{bare\_field\_name\}.  
3.   \*  
4.   \* @return  the $\{bare\_field\_name\}  
5.   \* @since   JDK 1.6  
6.   \*/**</****template****>****<****template** autoinsert="false" context="settercomment\_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment"**>**/\*\*  
7.   \* $\{param\}.  
8.   \*  
9.   \* @param   $\{param\}    the $\{bare\_field\_name\} to set  
10.  \* @since   JDK 1.6  
11.  \*/**</****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"**>**/\*\*  
12.  \* Creates a new instance of $\{enclosing\_type\}.  
13.  \*  
14.  \* $\{tags\}  
15.  \*/  
16. **</****template****>****<****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"**>**/\*\*  
17.  \* Project Name:$\{project\_name\}  
18.  \* File Name:$\{file\_name\}  
19.  \* Package Name:$\{package\_name\}  
20.  \* Date:$\{date\}$\{time\}  
21.  \* Copyright (c) $\{year\}, chenzhou1025@126.com All Rights Reserved.  
22.  \*  
23.  \*/**</****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"**>**/\*\*  
24.  \* ClassName: $\{type\_name\} <br/>  
25.  \* Function: $\{todo\} ADD FUNCTION. <br/>  
26.  \* Reason: $\{todo\} ADD REASON(可选). <br/>  
27.  \* date: $\{date\} $\{time\} <br/>  
28.  \*  
29.  \* @author $\{user\}  
30.  \* @version $\{enclosing\_type\}$\{tags\}  
31.  \* @since JDK 1.6  
32.  \*/**</****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"**>**/\*\*  
33.  \* $\{field\}:$\{todo\}(用一句话描述这个变量表示什么).  
34.  \* @since JDK 1.6  
35.  \*/**</****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"**>**/\*\*  
36.  \* $\{enclosing\_method\}:(这里用一句话描述这个方法的作用). <br/>  
37.  \* $\{todo\}(这里描述这个方法适用条件 – 可选).<br/>  
38.  \* $\{todo\}(这里描述这个方法的执行流程 – 可选).<br/>  
39.  \* $\{todo\}(这里描述这个方法的使用方法 – 可选).<br/>  
40.  \* $\{todo\}(这里描述这个方法的注意事项 – 可选).<br/>  
41.  \*  
42.  \* @author $\{user\}  
43.  \* $\{tags\}  
44.  \* @since JDK 1.6  
45.  \*/**</****template****>****<****template** autoinsert="false" context="overridecomment\_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment"**>**/\*\*  
46.  \* $\{todo\} 简单描述该方法的实现功能（可选）.  
47.  \* $\{see\_to\_overridden\}  
48.  \*/**</****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"**>**/\*\*  
49.  \* $\{tags\}  
50.  \* $\{see\_to\_target\}  
51.  \*/**</****template****>****<****template** autoinsert="false" context="newtype\_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype"**>**/\*\*  
52.  \* Project Name:$\{project\_name\}  
53.  \* File Name:$\{file\_name\}  
54.  \* Package Name:$\{package\_name\}  
55.  \* Date:$\{date\}$\{time\}  
56.  \* Copyright (c) $\{year\}, chenzhou1025@126.com All Rights Reserved.  
57.  \*  
58. \*/  
59. $\{filecomment\}  
60.   
61. $\{package\_declaration\}  
62. /\*\*  
63.  \* ClassName:$\{type\_name\} <br/>  
64.  \* Function: $\{todo\} ADD FUNCTION. <br/>  
65.  \* Reason:   $\{todo\} ADD REASON. <br/>  
66.  \* Date:     $\{date\} $\{time\} <br/>  
67.  \* @author   $\{user\}  
68.  \* @version    
69.  \* @since    JDK 1.6  
70.  \* @see        
71.  \*/  
72. $\{typecomment\}  
73. $\{type\_declaration\}  
74. **</****template****>****<****template** autoinsert="true" context="classbody\_context" deleted="false" description="Code in new class type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.classbody" name="classbody"**>**  
75. **</****template****>****<****template** autoinsert="true" context="interfacebody\_context" deleted="false" description="Code in new interface type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name="interfacebody"**>**  
76. **</****template****>****<****template** autoinsert="true" context="enumbody\_context" deleted="false" description="Code in new enum type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.enumbody" name="enumbody"**>**  
77. **</****template****>****<****template** autoinsert="true" context="annotationbody\_context" deleted="false" description="Code in new annotation type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name="annotationbody"**>**  
78. **</****template****>****<****template** autoinsert="true" context="catchblock\_context" deleted="false" description="Code in new catch blocks" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.catchblock" name="catchblock"**>**  
79. // $\{todo\} Auto-generated catch block  
80. $\{exception\_var\}.printStackTrace();  
81. **</****template****>****<****template** autoinsert="false" context="methodbody\_context" deleted="false" description="Code in created method stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodbody" name="methodbody"**>**  
82. // $\{todo\} Auto-generated method stub  
83. $\{body\_statement\}**</****template****>****<****template** autoinsert="true" context="constructorbody\_context" deleted="false" description="Code in created constructor stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name="constructorbody"**>**  
84. $\{body\_statement\}  
85. // $\{todo\} Auto-generated constructor stub  
86. **</****template****>****<****template** autoinsert="true" context="getterbody\_context" deleted="false" description="Code in created getters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.getterbody" name="getterbody"**>**return $\{field\};**</****template****>****<****template** autoinsert="true" context="setterbody\_context" deleted="false" description="Code in created setters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.setterbody" name="setterbody"**>**$\{field\} = $\{param\};**</****template****>****</****templates****>**

设置Code Templates的目的主要是为了统一各种注释的格式以及代码的模板，只要设定好Code Templates之后利用Eclipse就可以方便地生成我们自定义的注释，开发人员也容易接受！

[Eclipse_Code Templates]: /images/20220711/bd90b8d1f65847f380997a032903aa3b.png
[0a7cfe6a-7459-33e2-afec-3a6813628063.jpg]: /images/20220711/2822f7d755ba4eb2b4909f28016be039.png
[d4b683f0-da94-3725-aa92-41ff42fd947d.jpg]: /images/20220711/46706182b8274e49a486387b5cba8329.png
[icon_star.png]: /images/20220711/dc8be2a47633495bae86474a53cc6c76.png

发表评论取消回复

表情：

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

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

相关阅读

相关 Java注释模板

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][] 代码注释是对代码设计者、代码阅读者以及系统间调用提供了有

﹏ヽ暗。殇╰゛Y/ 2022年10月02日 07:59/ 0 赞/ 154 阅读

相关 java 注释模板

从工作开始，经历了几个项目的开发，现在的项目一般都是一个团队共同开发，而每个人都有自己的编码习惯，为了统一格式，项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置，但

女爷i/ 2022年07月12日 06:46/ 0 赞/ 181 阅读

相关 java 注释模板

从工作开始，经历了几个项目的开发，现在的项目一般都是一个团队共同开发，而每个人都有自己的编码习惯，为了统一格式，项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置，但

偏执的太偏执、/ 2022年07月12日 06:46/ 0 赞/ 227 阅读

相关 Eclipse设置Java代码注释模板

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

谁借莪１个温暖的怀抱￠/ 2022年06月16日 02:25/ 0 赞/ 249 阅读

相关 Elipse Java代码注释模板

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

系统管理员/ 2022年05月31日 03:20/ 0 赞/ 202 阅读

相关 Eclipse Java注释模板设置

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

小灰灰/ 2022年05月21日 20:44/ 0 赞/ 258 阅读

相关 Java注释模板

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][] 代码注释是对代码设计者、代码阅读者以及系统间调用提供了有

阳光穿透心脏的1/2处/ 2022年01月13日 05:05/ 0 赞/ 256 阅读

相关 Java注释模板

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][] 代码注释是对代码设计者、代码阅读者以及系统间调用提供了有

古城微笑少年丶/ 2022年01月13日 04:49/ 0 赞/ 220 阅读

相关 Java注释模板

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][] 代码注释是对代码设计者、代码阅读者以及系统间调用提供了有

约定不等于承诺〃/ 2022年01月13日 03:53/ 0 赞/ 261 阅读

相关 Java注释模板

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][] 代码注释是对代码设计者、代码阅读者以及系统间调用提供了有

小鱼儿/ 2022年01月13日 03:35/ 0 赞/ 255 阅读