参考自IntelliJ IDEA设置类注释和方法注释带作者和日期
效果展示
- 类注释:设置完成后再新建类效果如下
新建类时,类注释自动添加
- 方法注释:在方法前,输入’/‘,’*'+Tab键,效果
- 优化方法注释:参数分行注释效果
类注释,包含作者,创建日期
注释模板
/**
* Created with IntelliJ IDEA.
* @Author: 你的名字
* @Date: ${YEAR}/${MONTH}/${DAY}/${TIME}
* @Description:
*/
方法注释,包含返回类型,参数,描述
- 创建注释模板
- 在模板里填充内容
- 创建注释模板的快捷键
- 然后把模板放进Template text里面。再设置模板的默认值
注释模板
**
* @Description: $description$
* @Param: $params$
* @return: $returns$
* @Author: 你的名字
* @Date: $date$
*/
methodParameters()
methodReturnType()
date()
- 应用完成后,如果在方法前输入"/*"+Tab键没有出现方法注释,改动一下,选中打勾。或检查模板设置默认值:打开Edit variables检查所填几项是否输入错误
进阶,多参数每行放一个
参考自IDEA 方法注释模板设置(多参数分开不放一起)
修改模板内容
**
* @Description: $description$
* @Param: $param$
* @return: $returns$
*/
- param的Default value的内容,注意要勾选
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++){if(i==0){result = params[i] }else{result+='\\n'+'* @Param ' + params[i] + ((i < params.size() - 1) ? '' : '')}}; return result", methodParameters())