526互联

idea注释模板

发布时间 2023-05-06 18:13:37作者: molity

idea注释模板

 

类注释设置

File-->settings-->Editor-->File and Code Templates-->Includes-->File Header,粘贴如下内容即可。

记得把作者修改称自己，Apply后新建类和接口都会自动生成注释。

/**
  * @Description:
  * @Copyright:      Copyright (c)2019  ALL RIGHTS RESERVED.
  * @Company:        成都国盛天丰技术有限责任公司
  * @Author:         程立涛
  * @CreateDate:     ${DATE} ${TIME}
  * @UpdateDate:     ${DATE} ${TIME}
  * @UpdateRemark:   init
  * @Version:         1.0
  * @menu             ${description}
 */

 

方法注释设置

  1. File-->Settings-->Editor-->Live Templates

  2. 默认的快捷键

  3. 新建分组，名字随意写

  4. 新建的模板，输入的*，也可以输入其他习惯的字母

    因为IDEA生成注释的默认方式是：/*+模板名+快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为

    • /add+Tab），如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters(）、获取方法返回值的methodReturnType().

  5. 模板名，后面会用到。记住这个模板名

  6. 方法模板内容如下：

    *
 * @Description:    $description$
 * @Author:         程立涛
 * @UpdateUser:     程立涛
 * @Param: $param$
 * @Return: $return$
 * @CreateDate:     $date$ $time$
 * @UpdateDate:     $date$ $time$
 * @version:        1.0
 * @status:         done
*/

     

  7. 点击修改应用的地方，如下图选中Java：

  8. 模板的效果配置，如下图：

 

其中params变量的内容一定要放在Default value中！！！内容为：

groovyScript("if(\\"${_1}\\".length() == 2) {return '';} else {def result=''; def params=\\"${_1}\\".replaceAll('[\\\\\\\\[|\\\\\\\\]|\\\\\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ': '}else{result+='\\\\n' + ' * @param ' + params[i] + ': '}}; return result;}", methodParameters());

 

其中return变量的内容也一定要放在Default value中！！！内容为：

groovyScript("def returnType = \\"${_1}\\"; def result = '* @return: ' + returnType; return result;", methodReturnType());

 

 

Apply后，在方法上输入：/*+模板名+Tab键。

属性注释设置

属性上输入：/**+Enter键