发布时间: 阅读量

Idea 添加方法注释

Idea 添加方法注释

前言,刚开始写代码对注释没有概念,现在越来越能理解注释的重要性了,再一次配置注释,是因为要使用yapiUpload插件上传接口的时候,需要标准的注释,之前配置的注释方法参数读取不到!


先看一下最终的效果图

wei-xin-tu-pian-_20190821143732

步骤1.File -> Settings,Editor->Code Style ->Live Templates

wei-xin-tu-pian-_20190821144127

步骤2.先新建一个组

wei-xin-tu-pian-_20190821144246

步骤3.选中刚才建的组,点击加号

wei-xin-tu-pian-_20190821144457

步骤4.填写名称和注释这里以*为例

因为IDEA生成注释的默认方式是:/* +模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()

wei-xin-tu-pian-_20190821144621

步骤5.添加方法模板,代码粘贴到模板区

wei-xin-tu-pian-_20190821144907

**
 * @description:TODO
 * $VAR1$ 
 $params$ * @return $returns$
 * @author zf1017@foxmail.com
 * @creed: Talk is cheap,show me the code
 * @date $date$ $time$
 */

步骤6.点击下图按钮

wei-xin-tu-pian-_20190821145025

进行编辑,编辑完成后点击ok

wei-xin-tu-pian-_20190821145214

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

步骤7.点击Define ,勾选everywhere

wei-xin-tu-pian-_20190821145438

步骤8.点击 Apply-> OK

wei-xin-tu-pian-_20190821145708

最终我们在方法上使用的时候/*+tab键就ok


Idea版本2018.3.1
更多参考