企业的注释都有自己的一套格式规范,我们格式不是自己手动去输入,快速配置注释就十分的重要,同事,良好的编程习惯和写代码注释是十分重要的。
1:打开Eclipse/MyEclipse工具,点击菜单Window->Preferences弹出首选项设置窗口
2:展开左侧Java->Code Style->Code Template选项列表,就可以看到所有需设置注释的元素了
3:展开右侧模板选项Comments,可以看到可以设置的注释模板类型,包含Files,Types,Fields,Constructors,Methods等内容
4:选中之后点击Edit编辑在编辑框就可以编辑自己的注释模板
Comments下提供了以下9种类型的注释格式设置:
Files:文件注释格式
Types:类注释格式
Fields:属性注释格式
Constructors:构造注释格式
Methods:方法注释格式
Overriding methods:重写方法注释格式
Delegate methods:代理方法注释格式
Getters:Get方法注释格式
Setters:Set方法注释格式
注释模板
Files
/**
* @文件名称: ${file_name}
* @类路径: ${package_name}
* @描述: ${todo}
* @作者:XXX
* @时间:${date} ${time}
* @版本:V1.0
*/
Types
/**
* @类功能说明:
* @作者:${user}
* @创建时间:${date} ${time}
* @版本:V1.0
*/
Fields
/**
* @Fields ${field} : ${todo}
*/
Constructors
/**
*@类名:${file_name}
*@描述:{todo}
* ${tags}
*/
Methods
/**
* 方法功能说明:
* 创建时间:${date}
* 开发者:${user}
* @参数: ${tags}
* @return ${return_type}
* @throws
*/
Overriding methods
/*
* <p>标题: ${enclosing_method}</p>
* <p>描述: </p>
* ${tags}
* ${see_to_overridden}
*/
Delegate methods
/**
* ${tags}
* ${see_to_target}
*/
Getters
/**
* @return the ${bare_field_name}
*/
Setters
/**
* @param ${param} the ${bare_field_name} to set
*/