Eclipse-代码的自动注释&注释规范化

在使用Eclipse 编写Java代码时,必不可少地,我们都需要对代码进行注释,其中处于头位置的便是class类的注释了!Eclipse自带了快捷注释的功能!它会按照我们预先设置好的格式生成对应的注释。触发的功能快捷键是:

Alt +Shift + J

完全原创,转载请先询问

1. 修改默认注释模版格式:

 

打开菜单栏 Windows->Preferences->Java->Code Style->Code Templates

点击右边窗口中的Comments,可以看到有很多选项

comment

这些都是注释的类型,我们可以在此对注释信息模板进行编辑。各自对应的注释类型,请自己用google翻译即可,下面我将给出我在各个项目中使用的注释模版!

2. 个人常用模版推荐

 

2.1 Types 类型:类注释

 

编辑方法 :

选中Types,点击右边的Edit,把下面的代码复制进去即可

/**
 * @Title: ${type_name}
 * @Description: 类的描述
 * @author 作者名字qsuron
 * @date ${date}
 * @email 作者邮箱admin@qiushurong.cn
 */

效果:

comment_types

 

2.2 Fields 类型:字段注释

 

编辑方法 :

选中Fields,点击右边的Edit,把下面的代码复制进去即可

/**
 * 字段 ${field_type} : ${field}
 * ${todo}
 */

效果:

comment_fields

 

2.3 Constructors 类型:构造函数注释

 

编辑方法 :

选中Constructors,点击右边的Edit,把下面的代码复制进去即可

/**
 * 构造方法
 * ${tags}
 */

效果:

comment_construction

 

2.4 Method类型:方法注释

 

编辑方法 :

选中Method,点击右边的Edit,把下面的代码复制进去即可

/**
 * 方法 ${enclosing_method}
 * 方法描述
 * ${tags}
 * ${return_type}
 */

效果:

comment_method

 

2.5 Override类型:重写方法注释

 

编辑方法 :

选中Override,点击右边的Edit,把下面的代码复制进去即可

/**
 * 重写 ${enclosing_method}
 * ${see_to_overridden}
 */

效果:

comment_override

 

 

 

 

 

 

0%