IntelliJ IDEA为类和方法自动添加注释
阅读目录:
- 1、为类添加自动注释模版
- 2、为方法添加自动注释模版
阅读正文:
回到顶部
1、为类添加自动注释模版
File-->Settings-->Editor-->File and Code Templates
/**
* @author :mmzs
* @date :Created in ${DATE} ${TIME}
* @description:${description}
* @modified By:
* @version: $version$
*/
此时,当你创建新的类时,就会自动生成注释了。
注意:一定要启用该模板才有效
如果还不行,就添加如下设置:
回到顶部
2、为方法添加自动注释模版
File-->Settings-->Editor-->Live Templates
点击"+"号后,选择"Templates Group…"
注意:此处一定要为刚刚的模板指定使用范围:
例如:我指定的是java
注释模板填写内容参考如下:
/**
* create by: mmzs
* description: TODO
* create time: $date$ $time$
*
$params$
* @return $return$
*/
params的Exception内容如下:
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())
点击Ok。
此时,在方法体内部输入add+Tab就可以生成注释了。
作者:淼淼之森
欢迎任何形式的转载,但请务必注明出处。
如果你觉得本文还可以,那就点击一下推荐,让更多人看到吧!
限于本人水平,如果文章和代码有表述不当之处,还请不吝赐教。