IDEA 生成类和方法的注释信息

子非我鱼

已于 2024-01-12 17:45:28 修改

阅读量8.8k

点赞数 10

分类专栏： # IDEA 文章标签： java

于 2021-04-25 16:09:28 首次发布

本文链接：https://blog.csdn.net/qq_45752401/article/details/116130673

版权

IDEA 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

在这里插入图片描述

📫 作者简介：「子非我鱼」，专注于研究全栈
🔥 三连支持：欢迎 ❤️关注、👍点赞、👉收藏三连，支持一下博主~

文章目录

引言

在软件开发中，良好的代码文档是保持代码可维护性和可读性的关键。注释是代码文档化的一部分，它们提供了对类和方法的描述，帮助开发者和维护者更好地理解代码的目的和功能。本文将介绍如何使用 IntelliJ IDEA（以下简称 IDEA）快速生成类和方法的注释信息，以提高代码质量和可读性。

1. 新建class类，自动生成注释信息（选其一，否则会多出一份注释信息）

打开File -> Settings -> Editor -> File and Code Templates -> Files，找到class，然后输入如下信息即可。

/**
* @author: myqxin
* @Desc:
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

在这里插入图片描述

2，使用，新建一个类就会生成如下信息

在这里插入图片描述
以上只是对Class类进行了生成注释信息，想要对接口，枚举等，以上操作恢复出厂设置。

3，新建任意类，自动生成注释信息（选其一，否则会多出一份注释信息）

打开File -> Settings -> Editor -> File and Code Templates -> Includes，在File Header中添加如下信息，然后点击OK即可

/**
* @author: myqxin
* @Desc:
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

在这里插入图片描述

4，新建方法，自动生成注释信息

打开File -> Settings -> Editor -> Live Templates，点击+，选择Template Group，设置一个组名
在这里插入图片描述

然后在设置的组名下创建Live Template，选择你设置的组名，点击+，选择Live Template
Abbreviation填*，你可以填其他的，expand with默认Table，使用的时候输入/** + Table，(我这里填的myqxin，使用的时候输入/myqxin)就可自动生成方法注释，我的Template text如下(你没看错，params 前面没有*)，可以改成其他显示方式
在这里插入图片描述

点击Edit variables，选择各个参数对应的expression，其中params对应的脚本为：

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())

params这么写是为了让@param换行，如果选择methodParamters()，那么生成出来的@param是一个参数数组
在这里插入图片描述
最后，在方法上方输入/myqxin + table，展示如下

通过以上步骤，您可以在代码中快速生成规范的注释，提高代码的可读性和维护性。记得及时更新注释以保持其准确性，并养成良好的文档化习惯，使团队协作更加高效。