如何在Eclipse中自动添加注释

I. 如何自动添加注释

可通过如下三种方法自动添加注释：

1. 输入“/**”并回车。

2. 用快捷键 Alt＋Shift+J。

3. 在右键菜单中选择“Source > Generate Element Comment”。

II. 如何自定义注释格式

通过菜单 Window->Preference 打开参数设置面板，然后选择：

Java -> Code Style -> Code Templates



在右侧选择Comments,将其中的Files项，然后选右边的"Edit"，进入编辑模式：   



进入编辑模式后就可以自定义注释了。另外可以插入一些变量，如年、日期等等。



最后，确保 Code -> New Java files 中有："${filecomment}"



III. 导入/导出代码格式模板

通过“导出”和“导入”功能，你可以把自己的模板导出来在其他机器上使用。



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

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

*/

个人设置

Files:(文件注释:一般不需要添加)
/**
* @类名:${file_name}
* @功能描述:
* @作者:XuanKe'Huang
* @时间:${date} ${time}
* @Copyright @2014
*/
Typers:(类名注释)
/**
* @类名:${type_name}
* @功能描述:
* @作者:XuanKe'Huang
* @时间:${date} ${time}
* @Copyright @2014
*/
Fields:(变量)
/**
* @Fields ${field}:
*/
Methods:(方法)
/**
* @方法名: ${enclosing_method}
* @功能描述:
* ${tags}
* @return ${return_type}
* @throws
*/