idea自动生成类注释和方法注释

本文介绍如何在IntelliJ IDEA中配置自动生成类及方法注释,包括设置类注释模板和创建自定义Live Templates以快速生成方法注释。

一,自动生成类注释

打开Setting,选在Editor,然后是File and Code Templates 最后是Files 中的Class ,点击class后,编辑右边的红色边框,里边是模板,将模板设置好,点击ok即可。

 下边是模板中的示例代码。在新建类时,会提示description需要提前输入的,然后才会有。

/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: 作者名字
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

 二、自动生成方法注释

打开Setting,找到Editor ,选择 Live Templates, 点击右边加号为自己添加一个Templates Group 

然后选中自己的Group(我的是Test),再次点击加号添加Live Templates 。

然后出来一个模板设计页面,按照步骤做。

 

第四步点击后点击后,设置如下:

 

方法的注释模板:

/** 
* @Description: $description$ 
* @Param: $params$ 
* @return: $returns$ 
* @Author: Mr.Wang 
* @Date: $date$ 
*/ 

使用:将鼠标放在方法上边,然后按下你设置的快捷键,就可以了。

优化 IntelliJ IDEA 自动生成注释方法注释,可从以下方面着手: - **注释优化**: - **调整模板内容**:在 `File -> Settings/Preferences -> Editor -> File and Code Templates -> Files` 中,选择如 `Class` 等文件型,修改注释模板。例如将默认的 `/** * ClassName * * @Description //TODO * @Author $user$ * @Date ${DATE} ${TIME} **/` 中的 `//TODO` 改为更具体的描述提示,像 `@Description 该主要用于处理 [具体业务模块] 的相关逻辑` [^1][^5]。 - **添加更多元数据**:根据项目需求添加如 `@Version` 表明的版本号、`@Since` 说明从哪个版本开始引入等。示例如下: ```java /** * ClassName * * @Description 该主要用于处理用户信息的增删改查操作 * @Author $user$ * @Date ${DATE} ${TIME} * @Version 1.0 * @Since 1.2 */ ``` - **方法注释优化**: - **完善参数返回值描述**:IDEA 自动生成方法注释对于参数返回值描述可能不够详细,可手动完善。例如在 `Live Templates` 中自定义方法注释模板,使用脚本获取方法的参数返回值信息,并添加详细描述。 - **异常信息补充**:对于可能抛出的异常,详细说明异常产生的条件。示例如下: ```java /** * 计算两个整数的商 * * @param dividend 被除数 * @param divisor 除数 * @return 两个整数的商 * @throws ArithmeticException 当除数为 0 时抛出此异常 */ public int divide(int dividend, int divisor) { if (divisor == 0) { throw new ArithmeticException("除数不能为 0"); } return dividend / divisor; } ``` - **去除警告**:设置注释模板后可能会出现黄色警告,可通过调整模板语法或配置 IDEA注释检查规则来去除。例如,确保注释中的标签使用规范,避免使用不被支持的标签或语法错误 [^4]。
评论 13
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值