idea里边创建类的时候和方法自动生成注释

本文介绍了如何在IntelliJIDEA中设置自动为类和方法添加注释,包括创建类注释模板和自定义方法注释,以及使用groovy脚本获取参数和返回值信息。

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

我们经常写代码的时候需要在类上编写注释,标明这个类是谁写的有什么作用,其实每次写都会发现有很多相同的字段,比如作者,创建时间,类名等,有的时候方法上也要标明方法的返回值,参数等信息,在idea里边我们可以给设置自动加载注释。

1、创建类的时候自动加上注释

首先在idea里边选择file——setting根据如图所示进行操作

在includes里边的添加注释配置

/**
 * @Author qintianxian
 * @Date ${DATE} ${TIME}
 * @PackageName:${PACKAGE_NAME}
 * @ClassName: ${NAME}
 * @Description: TODO
 * @Version 1.0
 */


 点击apply,这里就配置成功了,点击ok就退出配置页面了,所以我就先apply一下,配置完方法注解再去进行测试,如果你退出去了也没事,原路找回来就行

2、在方法上添加注解(File–>Settings–>Editor–>Live Templates)

点击右上角的加号新建Template Group

 自己可以随意命名一个名字

 然后选中新建的这个组,然后点击右上角+号,选择Live Template

IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,且

因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为: /*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()


 当然这并不是所有人都是这样的,你可以选择你自己需要的参数留着

同样的方式再创建一个方法注解

*
 * @author: qintianxian
 * @date: $date$ $time$
 * @Description: TODO 
 $param$
 * @return: $return$
 */

 方法参数的获取用groovy脚本获取展示好一点,当然用下拉选择methodParameters()也行,只不过展示时就是一个数组型-即把参数[ ]装起来,个人觉得每个参数占一行比较好看,所以这里用groovy脚本获取:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}else{result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}}; return result", methodParameters())

选择ok,这样我们配置就结束了,就可以去进行测试操作了。 

设置成功后点击OK,首先我们先创建一个测试类,发现自动生成了,然后新建一个方法,写完入参和返回值以后,在方法上面:

         敲出:/** 回车

至此配置成功

### IntelliJ IDEA 自动生成注释的配置方法IntelliJ IDEA 中,可以通过设置文件代码模板来自动生成注释。以下是详细的配置过程: #### 1. 打开设置界面 进入 `File` -> `Settings` (Windows/Linux) 或者 `IntelliJ IDEA` -> `Preferences` (macOS),打开全局设置窗口。 #### 2. 进入模板设置页面 导航到 `Editor` -> `File and Code Templates` -> `Files` 页面,在右侧可以看到不同型的文件模板列表,其中包括 `Class` 模板[^3]。 #### 3. 编辑模板 点击选中 `Class` 模板,并在其下方的编辑框中输入所需的注释模板内容。例如,可以使用以下模板作为参考: ```java /** * @Project : ${PROJECT_NAME} * @File : ${NAME} * @Author : ${USER} * @Date : ${DATE} ${TIME} * @Description : 描述该的功能或用途。 */ public class ${NAME} { } ``` 此模板会自动生成带有项目名称、文件名、作者信息以及日期间等内容的注释[^5]。 #### 4. 应用更改并保存 完成模板编辑后,点击 `Apply` `OK` 按钮以应用修改并关闭设置窗口。 #### 5. 测试生成效果 新建一个 Java IDEA 将会在上方自动插入按照所设模板生成的注释--- ### 注意事项 - 如果发现设置了模板后出现了黄色警告提示(Warning),可能是因为某些占位符未被正确解析所致。此可尝试调整模板中的变量语法,或者忽略这些无害的警告信息[^4]。 - 自定义完成后可以根据实际需求进一步优化模板样式,比如加入更多元数据字段如版本号 (`@Version`) 等。 --- ### 示例代码块展示最终效果 当创建名为 `ExampleClass` 的新,将会得到如下结构: ```java /** * @Project : MyJavaProject * @File : ExampleClass * @Author : JohnDoe * @Date : 2023-10-07 14:23 * @Description : 此处填写关于此的具体描述。 */ public class ExampleClass { } ``` ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

加瓦咖啡

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

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

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

打赏作者

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

抵扣说明:

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

余额充值