Idea-Java代码注释规范

本文介绍了如何在IntelliJ IDEA中自定义Java代码注释模板,包括类、接口、枚举和注解的模板设置,以及方法注释的Live Templates配置,提供了详细的步骤和截图指导。

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

 

IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家(如果嫌配置繁琐,可以在本页面最下方下载jar包,导入idea,就可以了)。

一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)

1、File > settings > Editor > File and Code Templates > Files
我们需要设置的类模板有四个,Class、Interface、Enum、Annotation。
(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名 
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述 
(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME} 
(4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了 

这里贴出我的配置,Class、Interface、Enum、Annotation的配置都是一样的

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值