eclipse java 注释模板

   为了方便代码的可读性和可维护性，注释在java程序编写过程中是必不可少的。如何高效的使用和设计注释模板，对于一个程序员来说也是必要的技能。

   在Eclipse中注释模板的编辑路径：

Window --> Java --> Code Style --> Code Templates --> Comments --> types --> Edit 

根据 http://blog.163.com/lizhenming_2008/blog/static/765583332011115112725806/ 的博客设计了我自己的模板并上传，可直接导入：

  /**   
*    
* 项目名称：${project_name}   
* 类名称：${type_name}   
* 类描述：   
* 创建人：${user}   
* 创建时间：${date} ${time}   
* 修改人：${user}   
* 修改时间：${date} ${time}   
* 修改备注：   
* @version    
*    
*/ 

---------------------------------------------------------------------------------------------------------- 

设置注释模板的入口： 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} 

*/