Eclipse 注释模板的说明及设置(超详细)

1.在哪里里设置注解模板
设置注释模板的位置
①.找到工作菜单

在这里插入图片描述
②.依次点进Window --> Preference --> Java->Code Style --> Code Template(或直接查找Code Template)

在这里插入图片描述
③.点进Comments,按照下面所列的依次设定自动注释模板

[外链图片转存失败(img-WcCLjx3P-1569416737270)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\1569410602741.png)]
2.需要注释的元素说明
类型   说明
Files   文件
Types   类，接口
Fields   字段
constructors   构造函数
Methods   方法
Overriding methods   重写方法
Delegate methods   代理方法
Getter method   Bean中的get方法
Setter method   Bean中的set方法
3.注释模板的格式
点到需要设置的元素在点击edit(或者双击)
可以看到注释模板的格式都是以@xxx: 后面接一个EL表达式
EL表达式可以取出Eclipse对该元素注释的变量
点击下方的Insert Variable 可以查看该元素有哪些变量

/**
* @xxx: ${variable}
* @xxx: ${variable}
* @xxx: ${variable}
* @xxx: ${variable}
*/

1
    2
    3
    4
    5
    6

在这里插入图片描述
4.常用Variable
注意:不同元素所能使用的variable不同
Variable   格式   说明
date   $ {id：date [（format [，locale]）]}   日期
file_name   ${file_name}   文件名
git_config   $ {名称：git_config（user.name）}
$ {电子邮件：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}   重写的详细信息
5.我的注释模板
①Files 文件

/**
* @Title: ${file_name}
* @Description: ${todo}
* @author Jeremy
* @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')}
*/

1
    2
    3
    4
    5
    6

②Types 类

/**
* @ClassName: ${type_name}
* @Description: ${todo}
* @author Jeremy
* @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')}
*/

1
    2
    3
    4
    5
    6
    7

③Fields 字段

/**
* @Fields ${field} : ${todo}
* @author Jeremy
* @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')}
*/

1
    2
    3
    4
    5
    6

④Constructors 构造函数

/**
* @Constructor: ${enclosing_type}
* @Description: ${enclosing_type}构造函数
* @author Jeremy
* @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')}
*/

1
    2
    3
    4
    5
    6

⑤Methods 方法

/**
* @MethodName: ${enclosing_method}
* @Description: ${todo}
* @author Jeremy
* ${tags} ${return_type}
* @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')}
*/

1
    2
    3
    4
    5
    6
    7

⑥Overriding methods 重写方法

/**
* @MethodName: ${enclosing_method}
* @Description: ${todo}
* @author Jeremy
* ${tags}
* ${see_to_overridden}
* @date ${currentDate:date('yyyy-MM-dd hh:mm:ss')}
*/

1
    2
    3
    4
    5
    6
    7
    8
    9

5.如何使用注释及效果图
用快捷键Alt＋Shift+J可以为文件头快速添加注释。
在需要添加注释的方法，类之前输入/** 然后回车,就会出现注释
②类名

[外链图片转存失败(img-i095JxZw-1569416737274)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\1569416117629.png)]
④构造函数

[外链图片转存失败(img-8qVUXhm9-1569416737275)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\1569416132743.png)]
⑤方法

[外链图片转存失败(img-iA1YNSqA-1569416737277)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\1569416046870.png)]
⑥Overriding methods 重写方法

在这里插入图片描述
————————————————
版权声明：本文为CSDN博主「Jeremy__Yuan」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/Jeremy__Yuan/article/details/101386273

Eclipse 注释模板的说明及设置(超详细)相关推荐

eclipse注释模板修改时间为24小时制
在eclipse注释模板中,通常对@date 的格式设置为 ${date} ${time},如下所示: @date ${date} ${time} 此时在注释中显示的时间是12小时制,如果要改成24 ...
eclipse注释模板与格式化模板
不管是注释模板还是格式化模板,都是让我们的代码有一个统一的规范,可以方便程序员阅读,提高代码的可读性,对于代码后期维护提供了巨大的帮助. 一.注释模板一般我们在开发过程中固定注释表现为对文件.类.方 ...
eclipse 注释模板不生效问题
1.Eclipse注释模板设置在菜单栏的'windows/preferences'下的 java/Code Style/Code Templates.'comments/Methods'进行'Edi ...
修改Eclipse注释模板
9.修改Eclipse注释模板,如 ?? 解决方法:Window->preference
eclipse注释模板设置（未整理）
Window --> Java --> Code Style --> Code Templates --> Comments --> types --> Edit ...
eclipse注释模板_Intellij IDEA设置默认文档注释
idea开发环境配置一.类注释 File->setting Setting->File and Code Templates 我的文档注释模板: /*** @author: ${USER ...
Eclipse注释模板设置详解
设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素 ...
Eclipse 注释模板配置
一.依次点进Window --> Preference --> Java->Code Style --> Code Template,点进Comments,按照下面所列的依次设 ...
Eclipse注释模板注释快捷键
注释模板: /*** * @title: ${todo}(用一句话描述该文件做什么)* @author: ${user}* @since: ${date} ${time}* ${tags}*/ ecl ...

Eclipse 注释模板的说明及设置(超详细)

Eclipse 注释模板的说明及设置(超详细)相关推荐

最新文章

热门文章