IDEA设置类和方法注释模板

  • A+
所属分类:其他分类

一、设置类注释模板

1.打开IDEA依次点击File-->settings-->Editor-->File and Code Templates-->Files-->Class

IDEA设置类和方法注释模板

2.设置内容如下(可根据需要自行修改):

  • ${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
  • TODO:代办事项的标记,一般生成类或方法都需要添加描述
  • ${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些是IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}
  • 1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了
3.创建一个新类,效果如下:

IDEA设置类和方法注释模板

二、设置接口、枚举、注解等注释模板

  1. 打开IDEA依次点击File-->settings-->Editor-->File and Code Templates-->Files
    选择对应的设置项Interface,Enum,AnnotationType等选项进行设置。
  2. 设置方式参考设置类注释模板。

三、设置方法注释模板

IDEA没有智能到自动为我们创建方法注释,这就需要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释。

1.打开IDEA依次点击File-->settings-->Editor-->Live Templates

IDEA设置类和方法注释模板

2.新建模板组userDefine(名称可以自定义)

IDEA设置类和方法注释模板

IDEA设置类和方法注释模板

3.在新建的模板组下新建模板

IDEA设置类和方法注释模板

设置内容如下:

Abbreviation中填*

Description中填方法注释模板

Option中Expand with选择Enter

Template text中填:

IDEA设置类和方法注释模板

点击最下面带有感叹号的Define设置此模板用于什么地方:
选择Everywhere-->Java

IDEA设置类和方法注释模板

点击Edit variables编辑参数表达式:

IDEA设置类和方法注释模板

  • user设置:user()
  • time设置:time()
  • date设置:date()
  • param设置groovy脚本:

  • return设置:methodReturnType()
4.创建一个新方法,效果如下:

IDEA设置类和方法注释模板

weinxin
微信公众号
微信搜索Java技术宅或者扫描左边二维码进行关注,这样可以及时查看潘超博客每日内容推送

发表评论

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: