Ecplise设置注释模板
设置注释模板
修改入口:Window->Preference->Java->Code Style->Code Template
各个类型注释介绍
Files
Files标签是对新建的文件的说明,出现在文件最上面
/**
* Copyright © ${year} SJ.Tech Ltd. All rights reserved.
*
* @Package: ${package_name}
* @author: ${user}
* @date: ${date} ${time}
* @Description
*/
Type
Types标签是对类Class的一个说明,出现在类上面
/**
* Copyright: Copyright (c) ${year} SJ.Tech Ltd.
*
* @ClassName: ${file_name}
*
* @Description: 该类的功能描述
*
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time}
*
* Modification History:
* Date Author Version Description
*---------------------------------------------------------*
* ${date} ${user} v1.0.0 修改原因
*/
Fields
Fields标签是对变量字段的说明
/**
* @Fields ${field} : ${todo}(这个变量表示什么)
*/
Constructors
Constructors标签是对类的构造函数的说明
/**
* @Function: ${file_name}
* @Description: ${todo}(描述)
*
* ${tags}
*
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time}
*/
Methods
Methods标签是对函数方法的说明
/**
* @Function: ${enclosing_method}
* @Description: TODO(描述)
*
* ${tags}
*
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time}
*
* Modification History:
* Date Author Version Description
*---------------------------------------------------------*
* ${date} ${user} v1.0.0 修改原因
*/
Overriding Methods
Overriding Methods标签是对覆盖方法的说明
/**
* ${see_to_overridden}
* @Function: ${file_name}
* @Description: 该函数的功能描述
*
* ${tags}
*
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time}
*
* Modification History:
* Date Author Version Description
*---------------------------------------------------------*
* ${date} ${user} v1.0.0 修改原因
*/
Delegate Methods
代表方法
/**
* ${tags}
* ${see_to_target}
*/
Getter
/**
* @return: ${field_type} ${bare_field_name}
*/
Setter
/**
* @param ${param} set ${field_type} ${bare_field_name}
*/
添加注释快捷键
- 输入"/**"后回车
- shift + alt + j
- 右击选择 Source > Generate ElementComment
设置新增文件时自动创建注释
Window->Preference->Java->Code Style->Code Template,勾选Automatically and comments for new methods and types