代码注释模板（Eclipse）Java

实际编码时，我们尽量做到注释比代码多，在小组开发中，方便他人看代码和更快的熟悉业务。

接下来给大家一些模板，供大家参考，也给自己留存一下，方便以后查看。有什么更好的方法欢迎大家进行留言。

编写模板的步骤：Window->Preference->Java->Code Style->Code Template  

                   

接下来给大家介绍具体需要配置的模板

                  

1、文件（Fileds）的注释

/**  
 * All rights Reserved, Designed By www.tydic.com
 * @Title:  ${file_name}   
 * @Package ${package_name}   
 * @Description:    ${todo}(用一句话描述该文件做什么)   
 * @author: （编码人员或公司名称）
 * @date:   ${date} ${time}   
 * @version V1.0 
 * @Copyright: ${year} （公司的网址或公司的信息，是个人开发人员，不需要写） Inc. All rights reserved. 
 * （需要注意项）
 */

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

/**   
 * @ClassName:  ${type_name}   
 * @Description:${todo}(这里用一句话描述这个类的作用)   
 * @author: （编码人员或公司名称）
 * @date:   ${date} ${time}   
 *   
 * ${tags}  
 * @Copyright: ${year} （公司的网址或公司的信息，是个人开发人员，不需要写） Inc. All rights reserved. 
 * （需要注意项）
 */

3、字段(Fields)注释标签：

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

4、构造函数标签：

/**   
 * @Title:  ${enclosing_type}   
 * @Description:    ${todo}(这里用一句话描述这个方法的作用)   
 * @param:  ${tags}  
 * @throws   
 */

5、方法(Methods)标签：

/**   
 * @Title: ${enclosing_method}   
 * @Description: ${todo}(这里用一句话描述这个方法的作用)   
 * @param: ${tags}      
 * @return: ${return_type}      
 * @throws   
 */

6、覆盖方法(Overriding Methods)标签:

/**   
 * <p>Title: ${enclosing_method}</p>   
 * <p>Description: </p>   
 * ${tags}   
 * ${see_to_overridden}   
 */

7.代理方法(Delegate Methods)标签：

/**  
 * ${tags}  
 * ${see_to_target}  
 */  

8、getter方法标签：

/**  
 * @Title:  ${enclosing_method} <BR>  
 * @Description: please write your description <BR>  
 * @return: ${field_type} <BR>  
 */  

9.setter方法标签：

/**  
 * @Title:  ${enclosing_method} <BR>  
 * @Description: please write your description <BR>  
 * @return: ${field_type} <BR>  
 */