IDEA创建类注释模板

一、引言
在写Java代码过程中,当我们创建类的时候往往需要在类上写一些注释信息,而这些注释信息就主要是几个注释点,如果全部都手写就比较浪费时间了,这个时间后我们就可以通过使用注释模板添加自己的自定义的注释在类或者方法上。

二、IDEA 创建类注释模板方法
1、选择“File”→"settings..."

 

2、选择"Editor"->"File and Code",然后点击选择 "Files"。

 

3、 "Files"下面,我们分布点击Class、Interface和Enum时,可以发现右边显示框上都显示有下面这个代码:

#parse("File Header.java")

而这个代码意思是引入了File Header.java文件来作为我们创建的Class、Interface和Enum 等文件的注释,所以,我们只需要修改File Header.java就可以修改模板注释了。

4、点击“Includes”,选择“File Header”,然后在右边框里面添加模板注释代码,然后点击“OK”按钮。

/**
* @Classname ${NAME}
* @Description TODO
* @Version 1.0.0
* @Date ${DATE} ${TIME}
* @Created by ${USER}
*/

 

 

 

5、创建新类的时候将提示如下效果:

 

三、其他
1、可以通过使用下面提供的预定义变量自定义自己更加合适、详细的类注释模板。

${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} : 项目名称

 

 

原文链接:https://blog.csdn.net/GyaoG/article/details/120415660

posted @ 2023-02-28 18:04  ch3ny  阅读(1171)  评论(0编辑  收藏  举报