IDEA给【类】和【方法】设置作者和日期等注释(适合初学者)

目录

一:在Java类的开头自动注释作者名字和日期等信息

二:给Java的方法注释作者名字和日期等信息 

1. 不可修改的模板:Postfix Completion

2. 可修改的模板:Live Templates


 tips:前些天突然发现了一个巨牛的人工智能学习网站,通俗易懂,风趣幽默,忍不住分享一下给大家,感兴趣的同学可以点击网站进行学习人工智能学习网站

一:在Java类的开头自动注释作者名字和日期等信息

这样以后只要我们创建一个类,就会自动显示作者名和日期时间等信息,便于记录!

第一步:File--->Settings--->Editor--->Code Style--->File and Code Templates

第二步:选择File Header,进行注释信息的设置 

常用预设变量有:

 我们不妨写一个简单的注释信息:

/**
*@Author:朗朗乾坤
*@Package:${PACKAGE_NAME}
*@Project:${PROJECT_NAME}
*@name:${NAME}
*@Date:${DATE}  ${TIME}
*@Filename:${NAME}
*/

 ​​​​​把注释信息直接拷贝进去

第三步:这样我们以后每次创建一个类,就会自动生成注释信息,效果展示:

二:给Java的方法注释作者名字和日期等信息 

在 IDEA 中,Postfix Completion有很多内置的编码模板,使用者只需要敲击简单的前缀即可生成代码;但是这些模板是固定的无法改变鉴于 Postfix Completion 模板无法改变,IDEA 提供了 Live Templates 模板,该模板用户可以自定义

1. 不可修改的模板:Postfix Completion

File--->Settings--->Editor--->General--->Postfix Completion,里面有很多内置不可修改的模板

例如:一些常用的模板 ;给定一个父类Animals,一个子类Bird,并且子类有一个特有的doOther()方法,创建对象animals和bird

(1)animals.arg 就等价于加了一个括号 (animals)

(2)animals.cast 就等价于强制类型转换 ((Bird) animals)

(3)animals.castvar 就等价于强制类型转换并赋值 Bird animals1 = (Bird) animals;

(4)inst 就等价于instance然后转型 if (bird instanceof Object) { Object o = (Object) bird; }

(5)animals.inst 就等价于 animals instanceof Bird ? ((Bird) animals) : null;

(6)iter 就等价于 增强for循环 for (String arg : args) { }

         itar 就等价于  普通for循环

(7)animals.return 就等价于 return animals;

(8)souf 就等价于 System.out.printf("");

         sout 就等价于 System.out.println();

         soutv 就等价于 System.out.println("bird = " + bird);

(9)animals. null 和 ifn 就等价于 if (animals == null) { }

(10)animals.notnull 和 animals.nn 就等价于if (animals != null) { }

(11)list.for 生成list的for循环for (Object o : list) { }

(12)psfs 就等价于 public static final String

(13)prsf 就等价于 private static final ​

2. 可修改的模板:Live Templates

File--->Settings--->Editor--->Code Style--->Live Templates,里面有很多内置可修改的模板;我们可以进行修改已有的模板,也可以创建一个属于自己的模板

例如:创建一个注释模板,定义一个快捷键,这样以后只要我们,按下这个快捷键就会完成对方法的注释: 

第一步:创建一个模板组:myTemplates

第二步:创建模板:mdes

在自定义模板中,可以通过 $名称$ 的形式声明变量,然后使用 内置的函数 为变量动态的赋值。

/**
*@Date:$date$  // date变量下面会用内置函数进行赋值
*@Author:
*@return:
*
*/

 ​​​

第三步:点击Edit variables,使用 内置的函数date()为date变量动态的赋值


​ 

第四步:点击最下面的Define,设置模板的生效范围,分不清楚的话直接选Everywhere即可

第五步:这样以后给方法注释,先打出m就会有提示:

 然后回车就会自动生成注释信息:

### Jetbrains IDEA 配置文件头或行内注释模板设置方法 JetBrains IDEA 提供了强大的功能来定制代码中的注释模板,无论是文件头部还是行内的注释都可以通过简单的配置实现。 #### 文件头注释模板设置 1. 打开 **File | Settings** 菜单(对于 macOS 用户则是 **IntelliJ IDEA | Preferences**),进入 **Editor | File and Code Templates** 设置页面[^4]。 2. 在左侧列表中选择 **Files** 型下的模板项,比如 `Class` 或者 `Java File` 等特定型的文件模板。 3. 在右侧的大文本框中定义所需的文件头注释内容。例如: ```text /** * @author ${USER} * @date ${DATE} ${TIME} * @description ${NAME} */ ``` 上述占位符 `${}` 中的内容会由 IDE 自动替换为实际值,如当前用户名、日期时间以及文件名称等。 #### 行内注释模板设置 1. 同样打开 **Settings/Preferences** 对话框,导航到路径 **Editor | Live Templates** 下面进行自定义活码片段设定工作[^5]。 2. 添加新的 live template 并指定适用范围 (Applicable in),填写缩写词作为触发关键字,再编写期望生成出来的格式化字符串形式即可完成个性化需求满足过程;如果只是单纯修改默认行为,则找到对应条目调整其主体部分就好啦! ```java // Example of a custom line comment using abbreviation 'cm' public class Test { cm // Typing this will expand into below format automatically. /* * Custom Comment Block Start * * Your Content Here... * * Custom Comment Block End */ } ``` 以上就是在 JetBrains IDEA 中针对不同场景下如何灵活运用内置机制来自动生成标准化文档说明的方式介绍[^6]。
评论 21
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

@每天都要敲代码

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值