IDEA设置类注释模板和方法注释模板

本文介绍了如何在IntelliJ IDEA中设置类注释和方法注释模板。首先,通过File -> Settings -> Editor -> File and Code Templates设置类注释,修改File Header.java模板,利用预定义变量生成包含详细信息的注释。接着,通过Live Templates创建方法注释模板,设置完成后,可以在方法内输入自定义缩写并按Tab键快速生成注释。

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

1.设置类注释模板

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

选择Class、Interface、Enum等,在右侧区域中,public class 上面,都有一行 #parse("File Header.java")

这句代码是引入了File Header.java文件,作为我们创建的Class、Interface、Enum等文件的注释,这个类在Files右侧,有一个Includes选项,在这里,我们可以定义各种的模板,在需要的地方去引入这个模板,这里已经在类文件中引入了File Header.java 模板,那我们就更改这个模板成为我们想设置成的样子。

/**
*@description: 
*@Author: lmc
*@date: ${DATE} ${TIME} 
*/

*注:

${PACKAGE_NAME} :包路径

${NAME} :文件名

${USER} :主机用户名

${DATE} :系统当前日期,格式为:yyyy/mm/dd

${TIME} :系统当前时间 格式为:HH:mm

${YEAR} :当前年

${MONTH} :当前月

${MONTH_NAME_SHORT} : 月份名称简写;如:Jan, Feb, etc.

${MONTH_NAME_FULL} : 月份名称全拼;如:January, February.

${DAY} :当前天

${DAY_NAME_SHORT} :星期简写;如:Mon, Tue, etc.

${DAY_NAME_FULL} :星期全写;如:Mon, Tue, etc.

${HOUR} : 当前小时

${MINUTE} :当前分钟

${PROJECT_NAME} : 项目名称

2.设置方法注释模板

file->setting->Editor->LiveTemplates点击右边上面那个绿色的+号,选择Template Group双击,然后弹出一个窗口,随便添加一个名字,我这里添加的是MyCommentTemp。

还是在file->setting->Editor->LiveTemplates这个路径下点击一下刚刚你添加的那个名字(我这是MyCommentTemp),然后点击右边上面那个绿色的+号,选择LiveTemplate双击。

 填写下面图上的框

顺序不要错了。点击第④步的Define,勾选Everywhere。

点击第⑤步的按钮,弹出下面弹框,按图操作(注意,有下拉框,可以选择,免的自己输入时笔误)

到此,方法注释模版设置完成。

方法注释模板:

/** 
 * @Description $description$
 * @Param $param$
 * @return $returns$
 * @Author lmc
 * @Date $date$ $time$
 **/

使用:

在方法里输入add(这里的add是前面自己设置的),然后按下Tab键,这时就会生成方法注释。

(注意:add需要在方法里输入,生成的注释也会在方法里,手动移动到方法外,如果add输在方法外面,是没办法获取到方法参数的,这个可以自己试试)。

 参考:

IDEA生成类和方法注释模板设置(简单,详细)_越努力越有钱的博客-CSDN博客

IDEA 创建类注释模板和方法注释模板 - 简书

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值