Eclipse 注释模板配置以及设置护眼模式--超级超级详细

简介: Eclipse 注释模板配置以及设置护眼模式--超级超级详细

1、为什么要配置注释模板

在学习中中在必要的地方添加注释以便于自己和其他人理解代码,这就是注释的主要功能,
我们不希望发生几个月后只有上帝知道我们的代码是什么意思的情况,那将充分的证明代码不够优雅。

2、 如何去设置注释模板

1、打开修改位置

首先打卡Eclipse,依次点击Windows->Preference->java->Code Style->Code Templates->Comments

33ad8745a97c43d7a3db51a2121f6856.png

0974ef344ff54f8e94fbe7ae77f12ea1.png

2、需要注释的元素说明

8799f5e197aa4692a8cad918ceaa3d95.png

3、注释模板格式

点到需要设置的元素在点击edit(或者双击)
可以看到注释模板的格式都是以@xxx: 后面接一个EL表达式
EL表达式可以取出Eclipse对该元素注释的变量
点击下方的Insert Variable 可以查看该元素有哪些变量
注意:如果大家觉得看不到可以直接往下看,直接实例操作就行了。

4、我的注释模板

1、Files 文件

/**@Title: ${file_name}
*@Description: ${todo}
*@author zhm
@date d a t e {date}date{time}
/

2、Types类

/
*@ClassName: ${type_name}
*@Description: ${todo}
*@author zhm
@date d a t e {date}date{time}
/

3、Fileds字段

/
@Fields ${field} : ${todo}
*@author zhm
@date d a t e {date}date{time}
/

4、Constructors构造函数

/
*@Constructor: ${enclosing_type}
*@Description: ${enclosing_type}构造函数
*@author zhm
@date d a t e {date}date{time}
/

5、Methods 方法

/
@MethodName: ${enclosing_method}
@Description: ${todo}66
@return ${return_type}
@author zhm
@date d a t e {date}date{time}
/

6、Overriding methods 重写方法

/
@MethodName: ${enclosing_method}
*@Description: t o d o ∗ {todo} *todo∗{see_to_overridden}
*@author zhm
@date d a t e {date}date{time}
/

7、Delegate Methods 代表方法

/
${tags}
${see_to_target}
/

8、8.getter 方法

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

9.setter 方法

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

5、设置好了之后进行应用

d204ed77f8914734b7864dba2d87dbcc.png

6、部分注释展示

注意:要想实现注释要在想获取注释的部分的上面一行输入/**然后回车就能获取自己设置好的模板注释,会有具体实现,如下图。

注意:要想实现注释要在想获取注释的部分的上面一行输入/**然后回车就能获取自己设置好的模板注释,会有具体实现,如下图。

注意:要想实现注释要在想获取注释的部分的上面一行输入/**然后回车就能获取自己设置好的模板注释,会有具体实现,如下图。

这个很重要说三遍喽!!!

1、Types注释实现

a6526880bb144099946c8ae32b5d43c2.png

2、Constructors构造函数注释实现

78cb14094a524627b25c45a15ef20713.png

3、Methods 方法注释实现


afefffb7528b4603b39aa7c81d436727.png

Eclipse设置护眼模式(可以有效的保护程序员的眼睛哦)

1、找到设置的路径

Window–>Preferences–>General–>Editors–>Text Editor

如下图


4d5a953afead4346a6909399a2798a76.png

5113f05015fe44b99e4d84190affdbc9.png

2、开始设置

ed68efab297248b9a63f83df5df6ef1c.png

a3ce2c5aa0b34515b3894e27b45830ad.png

9ce0f82b5bc44fe0898b8a1f6c8cc4f6.png

选取自定义颜色的色块,然后点击确定。

6f8019a542b742dca3ac52a128cbd3ef.png

最后在页面点击apply然后点击OK就设置完成了!!!

2da8dc5303704ca9b973c0e5799c8201.png

设置完成的样子如下

cdfa073af10e497fa165abd536e4444b.png

如果大家想设置其他部分为护眼模式只需要选择如图框中的字段就可以喽

5e879d67fde942cd8da46ab7cb5d0c97.png

总结

  个人觉得注释非常主要,不仅仅对于自己还有其他teamer都很主要,对于自己可以快速获取自己
写的类或者方法等的作用而不用再去重新理清一下底层的逻辑,反过来说,如果想重新理清一下底
层逻辑,我们可以快捷的找到方法去梳理自己可能经过长时间然后遗忘的底层逻辑。对应队友的话
可以快速明白该类或方法的作用。我觉得程序员兄弟们应该都需要设置一下护眼模式,来保护自己
的眼睛,所有就加了这个设置。
大家如果觉得有用的话可以给我点个收藏或者赞吧。谢谢喽。
相关文章
|
3月前
|
Java Linux 开发工具
怎样下载安装Eclipse并配置开发环境?
Eclipse是一款非常流行的Java开发工具,它本身是开源的,适合多种多样的开发场景,深受Java开发者们的喜爱。今天我就跟大家介绍一下如何下载安装Eclipse,以及如何配置Eclipse的开发环境。
45 0
|
3月前
|
Java Maven Android开发
在Eclipse里配置Maven插件
Maven是一款比较常用的Java开发拓展包,它相当于一个全自动jar包管理器,会导入用户开发时需要使用的相应jar包。使用Maven开发Java程序,可以极大提升开发者的开发效率。下面我就跟大家介绍一下如何在Eclipse里安装和配置Maven插件。
48 0
|
5月前
|
SQL Java 应用服务中间件
Eclipse导入项目的配置步骤说明
Eclipse导入项目的配置步骤说明
139 0
Eclipse导入项目的配置步骤说明
|
1月前
|
Java 关系型数据库 应用服务中间件
JAVA Web项目开发eclipse工具包配置(第一天)
JAVA Web项目开发eclipse工具包配置(第一天)
|
3月前
|
XML Java Android开发
Java学习—Eclipse/Idea如何设置自动提示
Java学习—Eclipse/Idea如何设置自动提示
|
3月前
|
Java 应用服务中间件 Android开发
Tomat + Java配置 + eclipse下载
Tomat + Java配置 + eclipse下载
|
4月前
|
XML Java Android开发
eclipse设置修改编码与代码自动提示
eclipse设置修改编码与代码自动提示
51 1
|
4月前
|
算法 程序员 Apache
Windows下搭建SVN服务器并配置eclipse和idea
Windows下搭建SVN服务器并配置eclipse和idea
59 1
|
4月前
|
Oracle Java 关系型数据库
JAVAweb 的Eclipse配置及需要安装的jdk及tomcat 完整详细 搭配图片,详细易懂
JAVAweb 的Eclipse配置及需要安装的jdk及tomcat 完整详细 搭配图片,详细易懂
|
4月前
|
Java Maven Android开发
在 Eclipse 中配置使用 Maven
在 Eclipse 中配置使用 Maven
89 0