不忘初心
方得始终

IDEA生成类注释和方法注释模板

在每一个新建文件中生成注释

1. 打开Preferences
2. 打开:file->setting->Editor->Filr and Code Templates->Includes->File Header

注释代码:

/**
 * @program ${PACKAGE_NAME}
 * @description ${NAME}
 * @author 
 * @create ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 *
 */

在每一个文件中单独生成注释,在新建文件时会多一个步骤

3.Editor -> File and Code Templates -> Files -> Class

注释代码:

/**
 *@program ${PROJECT_NAME}
 *@description TODO ${description}
 *@author
 *@create ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 */

1. 打开Preferences

2. Editor -> Live Templates -> 点击右边加号为自己添加一个Templates Group -> 然后选中自己的Group再次点击加号添加Live Templates

配置模板下面是我的模板,大家仔细看我的模板开头没有/,这就是关键所在。

注释代码:

**
$params$
 * @return $ruturns$
 * @Description TODO $todo$ 
 * @author $user$
 * @date $date$ $time$
 */

@param参数获取代码:

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

然后点击 Define;然后是勾选 Everywhere

再编辑好模板之后就只为参数添加$$添加变量,点击右侧的 Editor variables,把变量一一对应选上

完成之后点击Apply然后点击OK,注意了,重点的地方,在你的方法上输入 /然后加上模板的名称todo,再按Tab键(注意啊不是按Enter键,而是按Tab键)就会出现你想要的注释了,很多教程是直接输入模板名称按tab键,但是这种方法的@param和@return是获取不到的,再重复一遍正确的方式:输入/和Abbreviation名,然后按Tab键;如果你取名为abc那就是 /abc 然后按Tab。效果如下:

赞(0) 支持我
未经允许不得转载:woytu » IDEA生成类注释和方法注释模板

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址