IDEA 配置注释模板

类注释

首先打开idea的类模板设置。 按钮顺序： File -> Settings -> Editor -> File and Code Templates
这里边上面有一个 Scheme 可供选择， 有Project 和 Default 两种选项可供选择。如果选Project。其他项目找不到喔。切记切记

模板内容如下：

/**
 * @description 
 * @className ${NAME}
 * @date ${DATE} ${TIME}
 * @author  作者名称
 */

方法注释

接下来进行方法的注释。 按钮顺序： File -> Settings -> Editor -> Live Templates
这个地方一般都自己重新创建一个 Template Group ， 然后在自己创建的 Template Group 下 创建 Live Template。这种的教程有很多。 简单的放俩图。

先把模板内容和 param / return 的 脚本发出来。 熟练操作的。下边就不需要看了。

第一个星号不是错误。因为 /* 的时候已经出来了前缀

*
 * 
 * $params$ 
 * @return $return$
 * @author 作者名称
 * @throws $exception$
 * @date $date$ $time$
 */

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 returnType = \"${_1}\"; def result ='';if(returnType=='null'||returnType=='void'){return result;}else{result += '' + returnType; return result;}", methodReturnType());

.

这个是我自己的配置，可以根据自己的习惯修改 一下。

.

注意： 这边有个问题哈， 必须要选择No applicable contexts 。 一般我都选择Java 即可。 这里如果不选择，下边的 Edit variables 不能配置。

这边按照图上的配完之后， 在一个方法上，直接 /** 加上Expand with 配置的 Tab 或者 Enter 或者其他的按键， 即可生成注释。非常的方便。

那么这个教程到这里就结束了。 感谢阅读。 希望可以为软件事业多做出一份贡献。 加油。