IntelliJ IDEA为类和方法自动添加注释

最新推荐文章于 2024-09-18 11:31:45 发布

原创最新推荐文章于 2024-09-18 11:31:45 发布 · 225 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #python #linux #php #mysql

本文详细介绍如何在IntelliJ IDEA中配置类和方法的自动注释模版，包括为类添加作者、日期等信息，以及为方法添加描述、参数、返回值等注释，提高代码规范性和可读性。

阅读正文：

1、为类添加自动注释模版

File-->Settings-->Editor-->File and Code Templates

/**
 * @author     ：mengw9
 * @date       ：Created By ${DATE} ${TIME}
 * @description：${description}
 * @modified By：
 * @version:     $version$
 */

此时，当你创建新的类时，就会自动生成注释了。

注意：一定要启用该模板才有效

如果还不行，就添加如下设置：

2、为方法添加自动注释模版

File-->Settings-->Editor-->Live Templates

点击"+"号后，选择"Templates Group…"

注意：此处一定要为刚刚的模板指定使用范围：

例如：我是全选

注释模板填写内容参考如下：

**
 * @Description $description$
 * @Param       $params$
 * @return      $returns$
 * @Author      mengw9
 * @Date        Create by $date$ $Time$
 */

这里为什么前面少写了个斜线，个人比较喜欢这使用的方式，使用方式：/ + a + Tab

点击Ok。

此时，在方法上方输入/ + a + Tab就可以生成注释了。

参考：https://www.cnblogs.com/mmzs/p/8858634.html