IDEA 自定义类和方法注释

1、类注释

1.1、方法一

设置→编辑器→文件和代码模板→文件→class 添加如下注释内容

注：此注释只有在新建类时有效，接口、枚举需要在对应的Interface、Enum上添加才有效

/**
 * //TODO
 *
 * @description //TODO
 * @createTime ${DATE} ${TIME}
 * @author ${USER}
 * @version v2.1.1
 */

 

效果：

 

1.2、方法二

设置→编辑器→文件和代码模板→包含→File Header

注：此方式class、Interface、Enum都有效

 

 2、方法注释

2.1、通过Live Template自定义方法注释

2.2、模板内容： 

要让模板中变量表达式生效在使用模板时是 /* + 模板名 + 展开方式，直接模板名+展开方式虽然也可以添加，但是变量中的表达式不会运行，此处第一行就是：*

* 
 * //TODO
 *
 * @description //TODO
 * @author $user$
 * @createTime $date$ $time$ 
 * @param $param$
 * @return $return$
 */

2.3、选择适用上下文

2.4、 编辑变量

 2.5、应用

在方法上输入 /**，然后按tab键(此展开建可以根据习惯修改)，效果如下：

 2.6、param改成JavaDoc样式

修改模板和变量表达式如下:

* 
 * //TODO
 *
 * @description //TODO
 * @author $user$
 * @createTime $date$ $time$ $param$ $return$
 */

 param表达式：

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

return表达式：

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())