IntelliJ IDEA 如何设置类头注释和方法注释
一、类头注释
打开 file -> setting -> Editor -> Filr and Code Templates -> Includes -> File Header
直接在右边的文件框里编辑你说需要注释的东西,然后应用保存之后,当你创建类的时候就会自动生成注释。
/**
* Description
*
* @author <a href="https://qiankunpingtai.cn">qiankunpingtai</a>
* @Date: ${DATE} ${TIME}
*/
二、方法注释
1、打开 file -> setting -> Editor -> LiveTemplates
点击右边上面那个绿色的 + 号,选择 Template Group 双击,然后弹出一个窗口,随便添加一个名字,我这里添加的是“java” -> OK
2、file -> setting -> Editor -> LiveTemplates
这个路径下点击一下刚刚你添加的那个名字(即刚创建好的“java”),然后点击右边上面那个绿色的 + 号,选择 LiveTemplate,填写下面的图上的框
"add" 缩写(之后打这个缩写,如 “add”,按“tab”就会自动出现注释),“Description”描述,“Templete text”注释模板
/**
* @return $returns$
* @author <a href="https://qiankunpingtai.cn">qiankunpingtai</a>
* description:
*
* @date: $date$ $time$
* $params$
*/
2、点击“Define”选择模板作用范围,
3、点击右下角的 Edit variables 按钮,然后弹出一个窗口,如下:
这里设置每个参数的值
4、之前要先选择好模板作用的语言范围(“Define”),这里表达式就有可选项
params 参数做特殊处理:
groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result='\\n'; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result}", methodParameters())
5、apply -> ok 保存
6、验证一下
/**
* @return java.util.Map<java.lang.String,java.lang.Object>
* @author <a href="https://qiankunpingtai.cn">qiankunpingtai</a>
* description:
*
* @date: 2020/2/10 17:58
*
* @param companyNumber
* @param softdogAmount
* @param identitycardAmount
* @param companyName
*/
*** 注意:*这里直接在方法外面加注释,获取不到参数和返回值,因为参数和返回的值只有在函数作用域内,intellij 才能找到。
所以快捷键最好还是在方法内部敲,再把注释复制出去。