idea自定义注释

前言

IDEA中设置注释模板主要分为两个部分，分别是文件头的注释和方法的注释。

文件头注释模板配置

打开设置

File | Settings | Editor | File and Code Templates 如下图。

输入代码

输入如下代码

File Header

代码

/***
 * @title $NAME
 * @author $USER
 * @blog https://dofi.eu.org
 * @date $DATE $TIME
 * @email 707437217@qq.com
 * @description 
 */

处理警告

因为这种@语法被识别为注解，对于强迫症的我很难接受，所以附上处理方法。

去除掉Javadoc declaration problems 注释警告

去除掉Link specified as plain text 链接警告

这样子就会变得很清爽了

如图

附上我的效果图

效果图

Java方法注释模板配置

打开设置

打开**File | Settings | Editor | Live Templates **

添加模板组

选择创建好的模板组添加模板

为模板组添加模板

设置模板信息

1.Abbreviation 触发条件填*

2.Description 描述随便写

3.Template text模板内容下面有代码块直接复制

4.Expand with Enter 展开方式，默认tab，我个人习惯Enter键

设置模板信息

*
$param$
 * @author $user$
 * @date $DATE$ $TIME$
 * @return $return$ 
 * @description: 
 **/

选择适用的文件类->Java

选择适用的文件类

修改变量值

Template Variables

Name	Expresson
param	下面代码块已贴出
user	user()
DATE	date()
TIME	time()
return	methodReturnType()

param代码块

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