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

前言

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

一、idea配置类注释

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

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

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

配置Abbreviation(快捷键)、Template text还有Edit variables
Java实用型-IDEA类注释和方法注释
Java实用型-IDEA类注释和方法注释

3.类注释配置文本信息

Abbreviation:C
Template text:
/**

  • @Description: java类作用描述
  • @Author: Songsong Huang
  • @Date: DATEDATE TIMETIME
    */
    Edit variables:
    DATE: date()
    TIME: time()

二、idea配置方法注释

1.新建方法Live Template

配置Abbreviation(快捷键)、Template text还有Edit variables
Java实用型-IDEA类注释和方法注释

2.配置Edit variables

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

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

Abbreviation:M
Template text:
**

  • @description 方法说明
  • @author Songsong Huang
    paramparam
  • @return returnreturn
  • @date datedate timetime
    /
    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) ? ‘\n\b’ : ‘’)}; return result", methodParameters())
    return: methodReturn Type

三、项目使用

1.添加类注释

按下类注释配置的Abbreviation:C,也就是快捷键,如下:
Java实用型-IDEA类注释和方法注释

2.添加方法注释

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

总结

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