IDEA自动生成注释模板的配置教程

目录

• 项目场景
• 配置方法
• 类注释模板
• 定义类开头的注释
• 步骤
• 类注释效果
• 方法注释模板
• 定义方法开头的注释
• 步骤
• 方法注释效果

项目场景

IDEA自动生成注释模板配置方法（包括类模板和方法模板）

配置方法

类注释模板

根据图片的步骤，进入设置类注编程释模板处进python行修改填入相应内容。

File ——> Settings ——> Editor ——> File and Code Templates ——>File Header

定义类开头的注释

/**
*@BelongphpsProject: ${PROJECT_NAME}
*@BelongsPackage:www.devze.com ${PACKAGE_NAME}
*@Author: xxxx
*@CreateTime: ${YEAR}/${MONTH}/${DAY}  ${HOUR}:${MINUTE}
*@Description: TODO
*@Version: 1.0
*/

在这个模板中，我们使用了

$ {PROJECT_NAME}、$ {PACKAGE_NAME}、$ {YEAR}、$ {MONTH}、$ {DAwww.devze.comY}、$ {HOUR} 和

$ {MINUTE} 内置的模板变量来自动生成当前项目名称、包名以及当前日期和时间。您可以在模板中编辑其他信息，如作者名、描述等。

步骤

类注释效果

方法注释模板

根据图片的步骤，进入设置类注释模板处进行修改填入相应内容。

File ——> Settings ——> Editor ——> Live Templates

定义方法开头的注释

方法注释模板

**
* @description: TODO $description$
* @author: LLong
* @date: $date$ $time$
$param$
* @return: $return$
**/

注意：修改Edit Varuavkes中需要定义的参数以及生成方式（如：Expand with 为 enter）

date 参数

date("yyyy/MM/dd")

time 参数

time("HH:mm:ss")

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()) 

return 参数

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())

步骤

方法注释效果

到此这篇关于IDEA自动生成注释模板的配置教程的文章就介绍到这了,更多相关IDEA自动生成注释模板内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！