idea设置类注释和方法注释(贼详细)

为了规范代码开发,我们需要用到开发工具的设置,比如类注释和方法注释的模板。 先说说在idea中如何设置类注释吧,第一步需要打开设置;

第二步打开文件和代码模板设置,并且找到类模板;

当我们设置完之后再次新建类的时候,就会出现这个弹框: 描述完类之后,就可以在新建的类上看到我们的注释了。 接下来就讲一下方法的模板吧,这一个比类的复杂一点,需要先创建自定义的模板组; 输入自己想要的分组名,即可创建模板分组; 创建完模板分组之后,在分组下创建想要的模板; 然后设置基础的模板信息,接下来一个一个讲解;

1、输入自己比较喜欢或者习惯的字符就可以,是为了配合第5步一起使用。 2、对这个模板的描述。 3、最好是拿着我的这个模板用,配合第6步里面的参数设置一起。第一行不需要加 / ,要不然会导致方法的出入参为空的,我们需要在使用的时候再用 / 加上我们第1步输入的字符,然后使用第5步的触发操作,就可以完成注释操作了。

4、选择作用域,可以选择所有,也可以只选择java。

5、这一步是为了设置触发动作,是按tab触发、回车触发还是其他方式触发,个人比较喜欢tab,配合**一起使用。

6、这一步是为了编辑我们设置的变量,date和time是可以选择固定的函数的,入参和出参如果选择了原有函数,会导致模板的样例过于丑陋,尤其是多泛型的情况,于是就对函数进行了处理。 这是使用默认出入参函数的情况,return的变量是真的丑,所以需要对函数进行处理。 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 += \n; result+= * @param  + params[i] + ((i < params.size() - 1) ? \n : )}; return result", methodParameters())

return:

groovyScript("def params="${_1}";def index=params.lastIndexOf(., params.indexOf(<));if(index!=-1){params=params.substring(index+1);};index1=params.lastIndexOf(<, params.indexOf(.));  index2=params.indexOf(.);while(index1!=-1&&index2!=-1){replaceTemp=params.substring(index1+1,index2+1);  	if(replaceTemp.indexOf(,)==-1){params=params.replaceAll(replaceTemp, );index1=params.lastIndexOf(<, params.indexOf(.)); 		index2=params.indexOf(.);}else{index1=params.lastIndexOf(,, params.indexOf(.));index2=params.indexOf(.);} 	  };if(params.indexOf(,)==-1){params=params.substring(params.lastIndexOf(.)+1);};return @return  + params", methodReturnType())

大家可以用上面这个函数,该函数对多泛型的情况进行了处理,如下图。

如果发现存在问题大家可以留言讨论。

经验分享 程序员 微信小程序 职场和发展