eclipse使用技巧——备注格式的定义与模板

eclipse使用技巧——备注格式的定义与模板

自定义生成备注格式的更改方式：

1. 打开Eclipse

2. 选择Windows下面的Preferences
   

3. 在导航栏里输入Java，找到Code Style ，下面有Code Templates
   

4. 点击右边的Comments
   

5. 选中Files并且点击Edit

6. 然后编写或者粘贴自己想要的模板，写完后点击OK
   

7. 如果想要创建相应文件的时候自动生成注释，则勾选下面的Automatically and comments for new methods,types…否则，不需要勾选。
   

8. 最后点击Apply and Close。

Comments下内容简介以及注释模板：

• Files（文件注释）

/**  
* @Title: ${file_name}  
* @Package ${package_name}  
* @Description: ${todo}(用一句话描述该文件做什么)  
* @author ${user}  
* @date ${date}  
* @version V1.0  
*/

• Types（类注释）

/**  
* @ClassName: ${type_name}  
* @Description: ${todo}(这里用一句话描述这个类的作用)  
* @author ${user}  
* @date ${date}  
* ${tags}  
*/  

• Fields（变量注释）

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

• Constructors（构造器注释）

/**  
* 创建一个新的实例 ${enclosing_type}.  
* ${tags}  
*/  

• Methods（方法注释）

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

• Getters

/**
 * @return the ${bare_field_name}
 */

• Setters

/**
 * @param ${param} the ${bare_field_name} to set
 */