IDEA生成代码注释与方法注释的配置方法


layout: post
author: Shannon Chen
catalog: true
tags:

- IDEA

在开发项目时,代码注释很重要。如果初期不注重代码规范,项目会在后期变得很难维护(当然如果是外包项目,一次交付注释写不写都没多大差别。),特别是核心业务人员离职后会严重影响项目开发的进度。

类注释配置方式

创建文件时自动生成类注释

-w1210

编辑处文本内容:

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/** 
 * 
 * @description
 * @author ${USER}
 * @time ${DATE} ${TIME} 
 */
public class ${NAME} {
}

上面的占位符可以动态的生成当前的作者,时间等信息,也可以自行添加更多的信息。

使用效果:

使用快捷键生成类注释

-w1209
上面的‘自定义’是我自己建的一个 group,里面可以放一些我们自己定义的快捷键,这里使用快捷键生成类注释我设置的是 'cc' ,当我们在 IDEA 的编辑器中敲击 'cc' 并按下 'tab' 键时会自动添加注释。

使用效果:

方法注释配置方式

-w1208
编辑处文本内容:

*
* $params$
* @return $returns$
* @description $content$      
* @author xianglong.chen
* @time $date$ $time$
*/

方法的注释配置方式比较特殊,因为 IDEA 为方法生成注释时是没有添加参数项的(如果需要添加参数项需要在函数的大括号中生成,然后移动到函数外部,操作比较繁琐),这是一件比较头痛的事情。一开始因为添加参数项操作比较繁琐自己都不愿意为函数添加注释,网上查了很多资料也没有一个很好的解决方式,后来在知乎上看到有人给出很好的解决方案,所以我在这里做一下总结。

为了能快速生成方法的注释我们需要做如下配置,这些配置是必须要这样做的,否则会无效,至于原因我也不知道。
1. 快捷键必须使用 '' ,也就是说 'Abbreviation' 必须要设置成 ''
2. '\$param\$' 必须要使用 groovy 脚本来生成,因为 IDEA 没有提供现成的函数

最后在 'Edit variables' 面板中配置函数:
-w524

'params' 参数后面的脚本:

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())

使用效果:

最后感谢 《IntelliJ IDEA 添加方法注释》 这篇文章的作者给出了完美的实现方式,因为之前参考的文章基本上都没有很好的实现思路,多半都是转载的。

发表评论

电子邮件地址不会被公开。 必填项已用*标注