IDEA中创建Java类时,自动在文件头中添加作者和创建时间,以及自定义方法注释

8 篇文章 0 订阅

1、类文件注释

路径:
Settings—>Editor—> File and Code Templates—>includes—>FileHeader
在这里插入图片描述

2、方法注释

setting->Editor->LiveTemplates点击右边上面那个绿色的+号,选择Template Group双击,然后弹出一个窗口,随便添加一个名字,我这里添加的是ydgroup然后点击OK
在这里插入图片描述
在这里插入图片描述
如果想为你的注释指定一些变量,可以利用 $ what$ 然后选择 Edit variables (注意只有当变量被$$包围是 右侧的Edit variables才可以点击)在里面选择idea提供的参数表达式
方法参数可以选择methodParameters()
返回值类型 methodReturnType()
在这里插入图片描述
在这里插入图片描述
此时我这里输入一个zha就会弹出提示,回车就能显示如下,但是如果在方法外面的话就不能显示参数和方法返回值
在这里插入图片描述
在这里插入图片描述
针对这种情况,我们可以使用IDEA自带的

/**

回车来进行方法注释

idea2022 文件头部注释是指在一个 Java 文件开头部分添加一段注释内容,用于描述这个的基本息、功能、作者和版本等相关息。 一般情况下,一个文件头部注释应包含以下内容: 1. 文件名和位置:注释应该标明这个文件文件名以及存放位置,以方便其他开发人员在需要时能够快速定位到这个文件。 2. 名和包名:注释应该标明这个名和所属的包名,以方便其他开发人员在阅读代码时能够准确地了解这个的功能。 3. 功能描述:注释应该简要地描述这个的主要功能和用途,以便其他开发人员在使用这个类时能够知道它的作用。 4. 作者息:注释应该标明这个作者姓名以及编写日期,以方便其他开发人员在需要时能够联系到作者并了解代码的编写背景。 5. 版本息:注释应该标明这个的版本息,包括版本号、修改日期等,以便其他开发人员在进行版本迭代时能够清楚地了解代码的变更历史。 一个典型的文件头部注释的例子如下: ``` /** * 文件名: Idea2022.java * 位置: com.example * 名: Idea2022 * 包名: com.example * * 功能描述: 这个是用于实现某个功能的核心,主要用于处理某些特定业务逻辑。 * * 作者: 张三 * 编写日期: 2022年1月1日 * * 版本: 1.0 * 修改日期: 2022年1月10日 */ ``` 通过在文件头部添加注释,可以使代码更具可读性和可维护性,方便他人理解和使用代码,并减少开发过程的沟通成本。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值