三分钟配置好IDEA速成类与方法的文档注释

类注释

1. file > setting > Editor > live Templates 或直接搜索 live Templates
   

2. 点击上图中右上角的 + 图标

3. 选择 Template Group
   

4. 输入组名称，比如 “myTemplate”
   
   设置完成：
   

5. 选中自定义好的组增加一个 Live Template
   
   这里选中 myTemplate 后，点击 + ，选择 Live Template
   设置完成：
   

6. 如图输入
   快捷键： *m （注意不要有多余的空格）
   注释：标准类和方法的文档注释 （可不写）
   

7. 选择需要在哪些文件中使用此注释文档的快捷生成方式
   
   按需选择 Java 或不选
   

8. 自定义生成的内容
   
   复制内容：直接全选复制黏贴，注意不要在第一个 * 前面加 /

*
 * @description $end$  $param$  $return$
 * @author dongua
 * @date $date$ $time$
 */

方法注释

1. 续上步，点击 Edit variabales
   
   进入之后：出现编辑参数的框框
   
2. 开始编辑参数
   如图：
   
   复制对应的参数值：全选直接复制黏贴进入 Expression

param：

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

return：

groovyScript("def returnType = \"${_1}\"; def result ='';if(returnType=='null'||returnType=='void'){return;}else{result += '\\n * @return ' + returnType; return result;}", methodReturnType());  

date 选择函数 date()

time 选择函数 time()

最后勾选上后四个参数的 Skip if defined

3. 点击 OK

看结果：

4. 类生成注释结果

5. 方法生成注释结果

在编写好方法之后，在方法上输入 /** 然后按下 enter 键

输入 /**

enter

输入 参数以及方法的说明注释
例：

当然在类上也是一样的

可能出现的问题

@date 可能会出现黄色的警告提示，将鼠标放上去，然后点击加入此 tab 后就不会再出现这样的警告了

到此IDEA速成类与方法的文档注释结束，希望对大家有所帮助哟！