1、文件->设置->编辑器->代码模板
2、点击右上角的绿色+号,然后选择template group ,然后输入group的name,随便输入就好了:pydGroup。然后点ok
3、选中刚才创建的pydGroup,然后再次点击右侧的绿色+,这次选择的是第一个1. Live Template。
4、配置模板
方法注释模板
(1)按照下图步骤进行配置,并配置相应内容(建议和图中相同);
模板文本:
* $params$ * @return $return$ * @description $description$ * @author Yandong Pang * @date $date$ */
(2)点击下方“Define”;
(3)点击右侧“编辑变量”;
名称及表达式对应如下:
params:
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) ? '\\r\\n' : '')}; return result", methodParameters())
return:
methodReturnType()
description:
保持空白即可
date:
date("yyyy-MM-dd HH:mm:ss")
(4)测试;
在方法头部输入 /** 然后按 tab键,此时自动生成注释(如下图)
类注释模板
(1)步骤同如上“方法注释模板”,但配置及模板文本不同(建议严格按照下图配置);
模板文本:
** * @description $description$ * @author Yandong Pang * @date $date$ */
(2)点击右侧“编辑变量”;
名称及表达式对应如下:
description:
保持空白即可
date:
date("yyyy-MM-dd HH:mm:ss")
(3)测试;
在类头部输入 /*c 然后按 tab键,此时自动生成注释(如下图)
注:在你的方法上输入 /*然后加上模板的名称*,这就是我为什么不取字母而取名为*,因为这样很快速,再按Tab键(注意啊不是按Enter键,而是按Tab键)就会出现你想要的注释了,很多教程是直接输入模板名称按tab键,但是这种方法的@param和@return是获取不到的,再重复一遍正确的方式:/** 然后按Tab键;如果你取名为abc那就是 /*abc 然后按Tab。
另有两个问题
(1)@param这个参数上报错了,这是因为idea强大的检查功能。
解决方案:File->settings->Editor->Inspections->javadoc issues下面第四项将红色 Error改为灰色Unused Entry即可
(2)@description、@date这两个参数上报警告了;另外如果参数报警告,则需要在参数后面加描述,如@param [user] 用户实体类
javadoc标签填写:description,date,param,return,exception,throw
解决方案:在设置中添加javadoc即可,如下图。
评论前必须登录!
注册