ideal如何设置默认文档注释

一、类注释

File->setting

Setting->File and Code Templates

我的文档注释模板：

 

/**
 * @author: ${USER}
 * @date: ${DATE} ${TIME}
 * @description:
 */

附：我的clion文档注释模板

/***********************************************************                                          *
* Time: ${DATE}                                           
* Author: $USER_NAME                                          
***********************************************************/

 

二、方法注释

IDEA还没有智能到自动为我们创建方法注释，这就是要我们手动为方法添加注释，使用Eclipse时我们生成注释的习惯是

/**+Enter，这里我们也按照这种习惯来设置IDEA的方法注释

1、File-->Settings-->Editor-->Live Templates

 

（1）新建组：命名为userDefine

 

（2）新建模板：命名为*

因为IDEA生成注释的默认方式是：/*+模板名+快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为

/*add+Tab），如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters(）、获取方法返回值的methodReturnType(）

 

（3）设置生成注释的快捷键

 

（4）设置模板：模板内容如下

注意第一行，只有一个而不是/

在设置参数名时必须用参数名的方式，否则第五步中读取不到你设置的参数名

*
 $param$
 $return$
 * @author: $user$
 * @date: $date$ $time$
 * @description:
 */

如果使用/生成的模板注释将会是如下效果：所以我们要去掉最前面的/

 

 

5）设置模板的应用场景

点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere-->Java即可

（如果曾经修改过，则显示为change而不是define）

 

 

（6）设置参数的获取方式

选择右侧的Edit variables按钮

PS:第五步和第六步顺序不可颠倒，否则第六步将获取不到方法

 

 

选择每个参数对应的获取方法（在下拉选择框中选择即可）

其中params变量的内容一定要放在Default value中！！！内容为：

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

其中return变量的内容也一定要放在Default value中！！！内容为：

groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; retu