MyEclipse新建文件时自动添加注释

windows->preferences->java->Code Templates->comments->Type->edit 

Eclipse注释规范模版总结

新建类文件

[java]  view plain  copy

1. /** 
2.  * @ClassName:     ${file_name} 
3.  * @Description:   ${todo}(用一句话描述该文件做什么)  
4.  *  
5.  * @author         ${user} 
6.  * @version        V1.0   
7.  * @Date           ${date} ${time}  
8.  */  

方法

[java]  view plain  copy

1. /**  
2.  * @Title:        ${enclosing_method}  
3.  * @Description:  ${todo}(这里用一句话描述这个方法的作用)  
4.  * @param:        ${tags}     
5.  * @return:       ${return_type}     
6.  * @throws  
7.  * @author        ${user} 
8.  * @Date          ${date} ${time}  
9.  */  

输入设置模板： 

[java]  view plain  copy

1. /**       
2. * ${file_name} Create on ${date}      
3. *       
4. * Copyright (c) ${date} by taotaosoft       
5. *       
6. * @author <a href="xiuzhong.li@gmail.com">Jerryli</a>      
7. * @version 1.0  
8. *      
9. */   

注意选择自动添加注释 

养成一个规范的习惯是最好的。 


选菜单 
windows-->preference 
Java-->Code Style-->Code Templates 
code-->new Java files 

选中点编辑 

[java]  view plain  copy

1. ${filecomment}   
2. ${package_declaration}   
3. /**  
4. * @author 作者姓名  E-mail: email地址  
5. * @version 创建时间：${date} ${time}  
6. * 类说明  
7. */   
8. ${typecomment}   
9. ${type_declaration}   

 

 Eclipse注释规范模版总结

1、  具体操作

（1）在eclipse中，打开Window->Preference->Java->Code Style->Code Template

（2）然后展开Comments节点就是所有需设置注释的元素，参照2注释规范对应设置即可

2、  注释规范

（1）文件(Files)注释标签

[java]  view plain  copy

1. /** 
2.  * FileName:     ${file_name} 
3.  * @Description: ${todo}(用一句话描述该文件做什么) 
4. * All rights Reserved, Designed By ZTE-ITS 
5.  * Copyright:    Copyright(C) 2010-2011 
6.  * Company       ZTE-ITS WuXi LTD. 
7.  * @author:    名字 
8.  * @version    V1.0  
9.  * Createdate:         ${date} ${time} 
10.  * 
11.  * Modification  History: 
12.  * Date         Author        Version        Discription 
13.  * ----------------------------------------------------------------------------------- 
14.  * ${date}       wu.zh          1.0             1.0 
15.  * Why & What is modified: <修改原因描述> 
16.  */  

 

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

[java]  view plain  copy

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

 

（3）字段(Fields)注释标签：

 

[java]  view plain  copy

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

 

（4）构造函数标签：

[java]  view plain  copy

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

 

（5）方法(Methods)标签：

[java]  view plain  copy

1. /** 
2.  * @Title: ${enclosing_method} 
3.  * @Description: ${todo}(这里用一句话描述这个方法的作用) 
4.  * @param: ${tags}    
5.  * @return: ${return_type}    
6.  * @throws 
7.  */  

 

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

[java]  view plain  copy

1.    
2. /** 
3.  * <p>Title: ${enclosing_method}</p> 
4.  * <p>Description: </p> 
5.  * ${tags} 
6.  * ${see_to_overridden} 
7.  */  

（7）代表方法(Delegate Methods)标签：

 

[java]  view plain  copy

1. /** 
2.  * ${tags} 
3.  * ${see_to_target} 
4.  */  

（8）getter方法标签：

 

[java]  view plain  copy

1. /** 
2.  * @Title:        ${enclosing_method} <BR> 
3.  * @Description: please write your description <BR> 
4.  * @return:     ${field_type} <BR> 
5.  */  

 

（9）setter方法标签：

[java]  view plain  copy

1.    
2. /**  
3.  * @Title:  ${enclosing_method} <BR>  
4.  * @Description: please write your description <BR>  
5.  * @return: ${field_type} <BR>  
6.  */