学步园

最常用的注释就是对类的说明和方法的说明，关于这类代码的注释方式，在Eclipse中可以这样进行设置： 

windows---preferences...---java--code style--code Templates---Comments就可以进行设置了。 

这里的设置包括常量和变量，变量的类型可以随时自动插入，就用insert varaibles....这个功能，会列出系统中提供的变量。 

文件注释标签： 

Java代码  

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

类型注释标签（类的注释）： 

Java代码  

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

字段注释标签： 

Java代码  

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

构造函数标签： 

Java代码  

1. /** 
2.  * 
3.  
4. Title:  
5.  
6.  * 
7.  
8. Description:  
9.  
10.  * ${tags} 
11.  */  

方法标签： 

Java代码  

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

覆盖方法标签： 

Java代码  

1. /* (非 Javadoc) 
2. * 
3.  
4. Title: ${enclosing_method} 
5.  
6. * 
7.  
8. Description:  
9.  
10. * ${tags} 
11. * ${see_to_overridden} 
12. */  

代表方法标签： 

Java代码  

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

getter方法标签： 

Java代码  

1. /** 
2. * @return ${bare_field_name} 
3. */  

setter方法标签： 

Java代码  

1. /** 
2. * @param ${param} 要设置的 ${bare_field_name} 
3. */  

新建Java文件： 

Java代码  

1. ${filecomment}  
2. ${package_declaration}  
3. /** 
4.  * @Title: ${file_name} 
5.  * @Package ${package_name} 
6.  * @Description: ${todo}(添加描述) 
7.  * @author A18ccms A18ccms_gmail_com 
8.  * @date ${date} ${time} 
9.  * @version V1.0 
10.  */  
11. ${typecomment}  
12. ${type_declaration}