关于Idea的注解配置

目录

1.Class自动生成注释

2.方法、通用注释

方法注释

通用注释

---

1.Class自动生成注释

Settings > Editor > File and Code Temlpates > Class/Interface/Enum/..

注释模板：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
  * @Description TODO
  * 
  * @Author  User Name
  * @Date ${DATE} ${TIME}
  *
  **/
public class ${NAME} {
}

图：

创建新Class的时候会自动加载：

类的注释是创建的时候自动生成的，大同小异，可以根据需求自己配置；

2.方法、通用注释

Settings > Editor > Live Templates

右侧'+'，Live Template 添加单独模板，Template Group 添加用户模板组

在这里添加模板组方便管理，然后添加 Live Temlpate。具体方式如下：

方法注释

创建：

Abbreviation：设置快捷符（缩写），根据自己习惯设置。我这里为9（下有图）

Description：说明，自由定义

Template text 注释模板（$参数$可以自定义）：

/**
 * @Author $user$
 * @Description //TODO $end$
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

接着在右侧Edit variables里设置参数获取方式：

 

Expression设置表达式获取参数，这里有自带的方法，也可以使用脚本

比如：

然后修改下面的参数获取方式（提示No applicable contexts yet后面）.点击Define，选择需要的：

设置好以后在方法里使用9+回车即可

这里的@Author是系统用户名，而且@Param在方法外的时候获取不到参数

后面上按照自己习惯配置，也可以在方法外获取参数：

这里这样写，根据配置可以在方法外获取参数：

**
 * @Description //TODO $end$
 $param$
 * @return 
 **/

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 ' : '')}; return result", methodParameters())

直接粘贴进去：

使用

比如方法service：

在方法上输入/* 按tab：

自动生成，@param后面也有参数：

使用//TODO比较明显

通用注释

通用注释更方便一点，只是按照自己设置的习惯就行了

比如这里只需要按/+回车就可以打出来，十分方便

回车：

不过想换行的时候对于行末的/进行回车就不太友好了，所以这里还是根据个人喜好设置吧。