Idea配置类头注释与方法注释(图文详解)

本文详细介绍了在IntelliJ IDEA中配置类头和方法注释的步骤。对于类头注释,需进入File > Settings > Editor > File and Code Templates > Includes,编辑File Header模板。方法注释的设置涉及Live Templates,通过添加模板并定义变量,实现自动生成带作者、描述、参数和返回值的注释。配置完成后,可以便捷地为新类和方法添加规范的注释。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

问题一:当使用Idea新建一个类时,如何自动生成类似下图的类头注释?

问题二:Idea怎么设置使用对应快捷键生成类似下图的方法注释?

 解决方法如下:

类头注释:

一、打开File > Settings > Editor > File and Code Templates > Includes

 

二、选择 File Header文件,直接在右边的注释模板中添加你想要添加的注释内容,然后点击Apply

应用就完成了

类头注释模板:

/**
* @Author admin
* @Description TODO
* @Date ${YEAR}/${MONTH}/${DAY}/${TIME}
* @Version 1.0
*/

方法注释:

一、打开File->setting->Editor->LiveTemplates,点击右边的“ + ”号,双击Template Group,然后就会弹出一个窗口 ,在该窗口命名方法注释的名称(随便命名)

 

 

 二、完成以上步骤之后,在模板上就可以看到你命名的名称,然后选择该名称,点击右边的” + “,然后双击Live Template,在出现的框里填写信息

方法注释模板:

/**
 * @Author admin
 * @Description 
 * @Param $params$
 * @Date $date$ $time$
 * @return $return$
 */

三、点击下方的Define,在弹出的窗口点击 Everywhere选择全部

 

 四、点击Edit variables,在弹出的窗口里选择参数和返回值的自动取值 ,最后点击Apply,然后OK即可

 五、效果展示

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值