IDEA设置专属注释模板

本文主要介绍如何用Intelij Idea配置类及方法的注释模板提高代码注释效率

一、类注释配置

创建文件后, 编译器会在类名前面生成固定的注释, 在阿里巴巴Java开发手册里也明确写到所有的类都必须添加创建者和创建日期。

1、配置效果

2、配置步骤

File → Settings → Editor → File and Code Templates → Includes → File Header

提供可复制注释模板 (✪ω✪)

/**
* @className: ${
     NAME}
* @description: TODO
* @author: fxh
* @date:  ${
     DATE} ${
     TIME}
* @version: 1.0
**/

3、其他说明

1、其他类注释配置方法
File → Settings → Editor → File and Code Templates → Files → Class

在public class 上面

#parse("File Header.java")

这是指在我们创建的Class Interface ,Enum 等文件里引入注释模板文件File Header.java，这个File Header.java正是我们以上修改的注释模板
可以在Includes 选项里，定义注释模板，在需要的地方去引入这个模板
也可以在Class，Interface，Enum文件里自定义注释

2、自定义注释模板不完全变量参考表
图片来源：https://blog.csdn.net/qxhly/article/details/105765166（侵删）

二、方法注释配置

1、配置效果

2、配置步骤

1、File → Settings → Editor → Live Templates

2、Template Group → 新建组：命名为Method Templates

3、Live Template → 新建模板：命名为 *

4、填写模板内容

①、Abbreviation 配置为 *
因为IDEA生成注释的默认方式是： /* + 模板名 + 快捷键
通常注释doc快捷键是 /** + Enter，所以这里设置了 *，快捷键设置的默认Tab

②、Description 自定义描述信息

③、Template Text 自定义注释模板

提供可复制注释模板 (✪ω✪)

*
 * @method: $medhod$
 * @description: TODO 
 * @author: fxh
 * @date: $date$ $time$
 * @version: 1.0
$params$ 
 * @return $return$
*/ 

注意：第一行，只有一个 * 而不是 /* 哦

④、Edit Vaule 关联变量

下拉选择关联变量
注意第三个参数是一个groovy脚本目的是把参数罗列出来
我是不是你们的小可爱 ⁄(⁄ ⁄•⁄ω⁄•⁄ ⁄)⁄

methodName()
date()
time()
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' : '')}; return result", methodParameters())  
methodReturnType()

5、创建方法，在方法上面操作：/** + Tab 就完成啦