Idea自动生成注释

原文链接

使用IDEA配置自动生成注释。

1 创建类时自动加注释

点击左上角菜单栏的 file -> Setting -> Editor -> File and Code Templates -> Includes -> File Header

输入如下内容：

/**
 *@Author: 代码的路
 *@Date: ${DATE} ${TIME}
 *@Param: 
 *@Return: 
 *@Description: 
 **/

然后新建一个类Test，可以看到类头已经有了自动生成的注释：

2 方法名前/属性名前加注释

点击左上角菜单栏的 file -> Setting -> Editor -> live Templates -> 2. Template Group：

输入 MyGroup ，然后确定，即可生成 MyGroup 这一项。选择 MyGroup ，点击 1.Live Template ：

Abbreviation输入自定义名称add，Template text 输入自己的模板，Define选择语言Java：

模板为：

/**
 * @Author: 代码的路
 * @Date: $date$ $time$
 * @Param: 
 * @Return: 
 * @Description: 
**/

选择 Edit variables，将 date 的 Expression 配置为 date()，将 time的 Expression 配置为 time()：

至此配置完成。

在写代码时，我们在方法前输入自己命名的 add，然后回车，即可出现自动注释：