超详细的 idea 类注释、方法注释、行注释配置（图文详解）

我只会发热2025-12-16 10:27

自己使用 idea 开发使用的自定义注释配置

1）打开 setting ------> Editor------> Live Templates

2）新建三个 Templaet Group：

类注释（zhanleai_class_template）
方法注释（zhanleai_method_template）
行注释（zhanleai_veriable_template）

1、类注释

在 zhanleai_class_template 下新建 Live Template
配置类注释
- 把下面这段话直接复制到 Template text，也就是下图中的第三步；
- Abbreviation填写 ** ，代表触发条件，后续会由 Template text 中的内容全部替代；
- $date$ 和 $time$ 是变量占位符，可以通过 Edit Variables 来进行编辑设置值内容；
- 下图中的第五步，Expand with 设置的是回车。意思是写了两个 ** 后再回车就触发该注释模板；

shell 复制代码

*
 * @Discription: 
 * @Author: zhanleai
 * @Date: $date$ $time$
 */

配置变量表达式（Edit Variables）
配置自定义类注释应用场景

2、方法注释

其他步骤跟类注释一样，但是多了两个参数：param 、return

shell 复制代码

*
 * @Discription: 
 * @Author: zhanleai
 * @Date: $date$ $time$$param$ $return$
 */

param参数填如下内容：

shell 复制代码

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 参数填如下内容：

shell 复制代码

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @Return ' + \"${_1}\"", methodReturnType())

这是我填写的内容
最后，记得修改自定义方法注释应用场景

3、行注释

行注释比较简单，就是一个 Template text
当然，切记要配置自定义类注释应用场景，不然没效果

4、最终实际使用

随便找个 java 类，在任意类名或方法名、变量名上输入 /** ，再回车，最后选择自己需要的注释模板就 OK 了