本篇主要讲如何进行注释模板的配置。下面将会说明如何通过 快捷键 + Tab 的方式直接呼出格式统一的类、方法、变量的注释模板。
目录
配置代码注释模板
1) 添加File Header模板
File->settings->Editor->File and Code Templates->includes; 添加一个File Header模板
/**
* TODO 写明类的作用
* @author ${USER}
* @project ${PROJECT_NAME}
* @title $title
* @package ${PACKAGE_NAME}
* @since ${DATE} ${TIME}
*/
2)配置FileHeader注释。
然后选择 Files -> Class -> 添加类文件头描述; 当然如果你想对Interface进行处理同样操作即可
3)自定义 Live Templates
打开IDEA Settings -> 搜索live Templates -> 点击 + 号创建一个自定义的 {这里最好填公司缩写,例如 whdsj} 注释模板。
![添加自定义group](https://i-blog.csdnimg.cn/blog_migrate/8ccdc0e3f53677e4274f4b69ec7040eb.png)
a) live templates配置
创建类、方法、常量的 live templates 模板
配置快捷键 c+Tab,代表快速生成class注释模板
/**
* @description *
* @author chentl
* @version 1.0
* @class $class_name$
* @package $package$
* @since $date$ $time$
*/
配置快捷键 m+Tab,快速生成method注释模板
/**
* TODO
* @author chentl
* @version v1.0.0
* @since $time$ $date$
$param$
* @return $return$
**/
配置快捷键 s+Tab,快速生成method注释模板
/**
* @description *
* @author chentl
* @since $date$ $time$
**/
b) 模板中的表达式配置
一般参考上图使用默认配置方式,另外$param$和$return$需要额外增加gs表达式。具体代码已经贴出来了,如下:
如果希望 @param 自动换行并且,出现鼠标悬停提示,需要遵循javadoc注释格式。那么在配置表达式时,method 和return需要特殊配置。将如下加粗内容复制到expression中即可。
// $param$ 表达式如下,复制到Expression中即可。
groovyScript(" if(\"${_1}\".length() == 2) { return ''; } else { def result='*'; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { if(i==0) result=' * @param ' + params[i] + ' ' + params[i] + '\\r\\n'; else result+=' * @param ' + params[i] + ' ' + params[i] + ((i < params.size() - 1) ? '\\n' : '\\n') }; return result } ", methodParameters())
// $return$ 表达式如下,复制到Expression中即可。
groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())
![](https://i-blog.csdnimg.cn/blog_migrate/077b5342ea3ab265d91a06225ae09533.png)
c) 使用快捷键初始化模板
设置好以后,在Class类上一行,方法上一行,或者常量上一行使用快捷键 s或m或c + Tab 即可快速呼出模板。
验证
创建Class,Method,Constants 使用c+Tab \ m+Tab \ s + Tab 进行验证