Java实用型-IDEA类注释和方法注释

前言

每次写java代码,都需要类注释和方法注释,自己配置一些快捷键会使开发更加便捷

一、idea配置类注释

1.mac直接按快捷键“command+,”打开Live Templates

2.新建类注释Live Template,配置相关信息

配置Abbreviation(快捷键)、Template text还有Edit variables

3.类注释配置文本信息

Abbreviation:C Template text: /**

    @Description: java类作用描述 @Author: Songsong Huang @Date: D A T E DATE DATE T I M E TIME TIME */ Edit variables: DATE: date() TIME: time()

二、idea配置方法注释

1.新建方法Live Template

配置Abbreviation(快捷键)、Template text还有Edit variables

2.配置Edit variables

3.方法注释配置文本信息

Abbreviation:M Template text: **

    @description 方法说明 @author Songsong Huang p a r a m param param @return r e t u r n return return @date d a t e date date t i m e time time / Edit variables: param: groovyScript(“def result=’’; def params=”${_1}".replaceAll(’[\[|\]|\s]’, ‘’).split(’,’).toList(); for(i = 0; i < params.size(); i++) {result+=’ @param ’ + params[i] + ((i < params.size() - 1) ? ‘ ’ : ‘’)}; return result", methodParameters()) return: methodReturn Type

三、项目使用

1.添加类注释

按下类注释配置的Abbreviation:C,也就是快捷键,如下:

2.添加方法注释

按下方法注释配置的Abbreviation:M,但是Template text里的配置少一个"/",所以需要/+M,才能正确配置方法注释。如下:

总结

以上就是idea配置方法注释和注释的过程,几乎是每个java开发者的必备,感兴趣的按照以上步骤试试。

经验分享 程序员 微信小程序 职场和发展