我们在开发项目的时候会要求加入代码注释,所以需要自定义注释模板,下面提供类、方法的自定义注释
一、在类上加入注释模板,Ctrl+Alt+S 打开Settings,选择Editor-->File and Code Templates-->Class ,如下图
类注释模板:
/** * @Description: * @Author: Author * @CreateDate: ${DATE} ${TIME} **/
二、在方法上加入模板,Editor-->Live Templates-->点击右上角加号创建Template Group,然后在自己创建的Group中创建Live Template,如下图
方法注释模板内容:
/** * @Description: $params$ * @Return: $return$ * @Author: Ni Fujia * @CreateDate: $dates$ $time$ */
选择Edit variables ,分别选择下图内容,params 中的Expression 自己定义,定义内容为:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n\\b' : '')}; return result", methodParameters())
最后apply,如下图
下次创建类的时候就会默认在类的前面加入注释,创建方法的时候,使用func,按Table 键,就可以生成方法注释模板
(注:在方法外生成模板也可以,但是生成的模板Param 都为空,所以建议在方法内部生成,再剪切到方法外部)
三、最终效果如图所示