Intellij IDEA 类注释模板设置

本文详细介绍了如何在IntelliJIDEA中配置全局USER以替换自动生成注释中的作者信息,以及如何设置FileHeader注释模板。同时提到JavaDoc的相关配置以保持注释格式一致。
摘要由CSDN通过智能技术生成

1、配置全局USER

在此配置全局USER,用于填充自动生成的注释中的作者@author属性。

注释模板中的user参数是默认是获取系统的用户(当然注释作者也可以直接写固定值),如果不想和系统用户用同一个信息,可以在IDEA中进行配置。IDEA依次打开Help->Edit Custom VM Options...。在最下面增加一行 -Duser.name=username

其中username就是你希望为user参数的赋值配置类注释模板(配置后需要重启IDEA生效)。

2、配置注释模板

Preferences -> Editor -> File and Code Templates -> Includes -> File Header
模板配置的路径
注释模板内容:

/**
 * @project ${PROJECT_NAME}
 * @description: ${description}
 * @author ${USER}
 * @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 * @version 1.0
 */

配置完成后,就可以新建一个类进行测试了。新创建java文件时,会提示输入类描述description

如果发现新建的文件注释顺序和模板不一样,可以检查下如下的配置:
Preferences->Editor->Code Style ->Java->JavaDoc 中的配置(取消勾选):
配置

  • 4
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值