Eclipse 注释模板配置

一、依次点进Window --> Preference --> Java->Code Style --> Code Template，点进Comments,按照下面所列的依次设定自动注释模板

二、需要注释的元素说明

Files	文件
Files	文件
Types	类，接口
Fields	字段
constructors	构造函数
Methods	方法
Overriding methods	重写方法
Delegate methods	代理方法
Getter method	Bean中的get方法
Setter method	Bean中的set方法

三、.注释模板的格式
点到需要设置的元素在点击edit(或者双击)
可以看到注释模板的格式都是以@xxx: 后面接一个EL表达式
EL表达式可以取出Eclipse对该元素注释的变量
点击下方的Insert Variable 可以查看该元素有哪些变量

四、常用Variable
注意:不同元素所能使用的variable不同

Variable	格式说明
date	$ {id：date [（format [，locale]）]} 日期
file_name	${file_name} 文件名
git_config	$ {名称：git_config（user.name）} 从Git配置中检索一个值
git_config	$ {电子邮件：git_config（user.email）} 从Git配置中检索一个值
package_name	${package_name} 包名
project_name	${project_name} 项目名
type_name	${type_name} 类名
return_type	${return_type} 返回值类型
tags	${tags} 生成Javadoc标记（包括@ param，@ return ）
enclosing_method	${enclosing_method} 方法名
enclosing_type	${enclosing_type} 类名
see_to_overridden	${see_to_overridden} 重写的详细信息

五、我的注释模板
1.Files 文件
/**

@Title: ${file_name}
@Description: ${todo}
@author ??
@date ${currentDate:date(‘yyyy-MM-dd HH:mm:ss’)}
*/

2.Types 类
/**

@ClassName: ${type_name}
@Description: ${todo}
@author ??
@date ${currentDate:date(‘yyyy-MM-dd HH:mm:ss’)}
*/

3.Fields 字段
/**

@Fields ${field} : ${todo}
@author ??
@date ${currentDate:date(‘yyyy-MM-dd HH:mm:ss’)}
*/

4.Constructors 构造函数
/**

@Constructor: ${enclosing_type}
@Description: ${enclosing_type}构造函数
@author ??
@date ${currentDate:date(‘yyyy-MM-dd HH:mm:ss’)}
*/

5.Methods 方法
/**

@MethodName: ${enclosing_method}
@Description: ${todo}
${tags}
@return ${return_type}
@author ??
@date ${currentDate:date(‘yyyy-MM-dd HH:mm:ss’)}
*/

6.Overriding methods 重写方法
/**

@MethodName: ${enclosing_method}
@Description: ${todo}
${tags}
${see_to_overridden}
@author ??
@date ${currentDate:date(‘yyyy-MM-dd HH:mm:ss’)}
*/

7.Delegate Methods 代表方法
/**

@MethodName: ${enclosing_method}
@Description: ${todo}
${see_to_target}
${tags}
@author zhangmm
@date ${currentDate:date(‘yyyy-MM-dd HH:mm:ss’)}
*/

8.getter 方法
/**

返回 ${bare_field_name} 的值
@return ${bare_field_name}
*/

9.setter 方法
/**

设置 ${bare_field_name} 的值
@param ${param} 参数设置变量 ${bare_field_name} 的值
*/

Eclipse 注释模板配置相关推荐

eclipse注释模板与格式化模板
不管是注释模板还是格式化模板,都是让我们的代码有一个统一的规范,可以方便程序员阅读,提高代码的可读性,对于代码后期维护提供了巨大的帮助. 一.注释模板一般我们在开发过程中固定注释表现为对文件.类.方 ...
eclipse注释模板修改时间为24小时制
在eclipse注释模板中,通常对@date 的格式设置为 ${date} ${time},如下所示: @date ${date} ${time} 此时在注释中显示的时间是12小时制,如果要改成24 ...
修改Eclipse注释模板
9.修改Eclipse注释模板,如 ?? 解决方法:Window->preference
eclipse 注释模板不生效问题
1.Eclipse注释模板设置在菜单栏的'windows/preferences'下的 java/Code Style/Code Templates.'comments/Methods'进行'Edi ...
eclipse注释模板_Intellij IDEA设置默认文档注释
idea开发环境配置一.类注释 File->setting Setting->File and Code Templates 我的文档注释模板: /*** @author: ${USER ...
IntelliJ IDEA类和方法注释模板配置
1.设置文件注释设置Java类的注释模板,创建Java类自动生成该注释模板. 先看文件注释效果: 1.1.选择 IntelliJ IDEA -> 选择 Preferences... 打开IDE ...
Eclipse 注释模板的说明及设置(超详细)
1.在哪里里设置注解模板设置注释模板的位置 ①.找到工作菜单在这里插入图片描述 ②.依次点进Window --> Preference --> Java->Code Style ...
eclipse注释模板设置（未整理）
Window --> Java --> Code Style --> Code Templates --> Comments --> types --> Edit ...
Eclipse注释模板注释快捷键
注释模板: /*** * @title: ${todo}(用一句话描述该文件做什么)* @author: ${user}* @since: ${date} ${time}* ${tags}*/ ecl ...

Eclipse 注释模板配置

Eclipse 注释模板配置相关推荐

最新文章

热门文章