自定义注释模板
文章简介
这篇博客来介绍下在 idea
中设置java的 类
和 方法
上面的 注释模板
.
1. 类文件自动生成注释模板
使用 idea
新建 java类
时,该配置会自动按照模板生成类文件的 注释
信息,具体的模板设置过程如下
设置路径:File/Settings/Editor/File and Code Template
,选择 Includes
标签,点击 File Header
选项,把注释模板代码拷贝到里面.
/**
* @description: todo
* @author: wzl & hello world
* @date: ${YEAR}/${MONTH}/${DAY} ${TIME}
* @gitee: https://gitee.com/weizl0524
* @github: https://github.com/wzlUp
* @motto: Stay hungry, stay foolish.
*/
可以根据自定的爱好进行模板设定,显示效果如下:
2. 方法自动生成注释模板
新建方法类的时候,我们来设置一个类的注释模板,快速进行代码注释
🍉🍉 设置路径:File/Settings/Editor/Live Templates
,点击右上角的+按钮,选择 Template Group...
🍣🍣 新建一个 Template Group
后,命名 MySetting
🍤🍤 选中 MySetting
后,点击右侧+按钮,选择 Live Template
新建一个 Template,Abbreviation 输入 *,Template Text 填写如下代码:
**
* @notes todo
* @author wzl & coffee
* @date $date$ $time$ $param$ $return$
*/
🍞🍞 点击右侧的 Edit variables 按钮,设置上面添加的相关参数
param参数设置
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())
return参数设置
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())
当输入 /*
在家 Tab
组合键,就会按照类注释模板生成注释代码,效果如下
/**
* @notes todo
* @author wzl & coffee
* @date 2023/02/12 14:01
* @param key
* @param value
* @param timeout
* @param timeUnit
*/