详细:idea如何设置文件头注释和方法注释

本文介绍如何在IntelliJ IDEA中配置类头和方法注释模板,包括自定义注释格式、参数获取方式及应用场景设置。

idea:

类头注释:打开file->setting->Editor->Filr and Code Templates->Includes->File Header 
这里写图片描述
直接在右边的文件框里编辑你说需要注释的东西,然后应用保存之后,当你创建类的时候就会自动生成注释。

方法注释:打开file->setting->Editor->LiveTemplates点击右边上面那个绿色的+号,选择Template Group双击,然后弹出一个窗口,随便添加一个名字,我这里添加的是MyGroup然后点击OK 
这里写图片描述

还是在file->setting->Editor->LiveTemplates这个路径下点击一下刚刚你添加的那个名字(我这是MyGroup),然后点击右边上面那个绿色的+号,选择LiveTemplate双击,填写下面的图上的框 
这里写图片描述
然后点击这里写图片描述 
然后选择Everywhere 
这里写图片描述

最后点击右下角的Edit variables 按钮,然后弹出一个窗口,如下: 
这里写图片描述
如果想把 @param:每一个参数可以这样 
这里写图片描述
参数值要自己写的

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

把这个添加进去,但是还要注意一点: 
这里写图片描述 
下面红色圈中的下拉框选择相对应的参数点击OK 
再点击apply,点击Ok。 

然后写方法之前点写上add(刚刚填的)按tab,注释就出来了。


第二篇

-------------------------------------------------------------------------------------

IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。

这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置:

类注释模板:                                                                      方法注释模板:

    

一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)

1、File-->settings-->Editor-->File and Code Templates-->Files

我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)

(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名

(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述

(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}

(4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了

2、效果图展示

二、设置方法注释模板

IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是

/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

1、File-->Settings-->Editor-->Live Templates

(1)新建组:命名为userDefine

(2)新建模板:命名为*

因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为

/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、

获取方法返回值的methodReturnType()

(3)设置生成注释的快捷键

(4)设置模板:模板内容如下

注意第一行,只有一个*而不是/*

在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名

如果使用/*生成的模板注释将会是如下效果:所以我们要去掉最前面的/*

(5)设置参数的获取方式

选择右侧的Edit variables按钮

选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本

的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数

(6)设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可

(如果曾经修改过,则显示为change而不是define)

(7)效果图

创建方法,在方法上面写:/*+模板名+Enter-->/**+Enter



在 IntelliJ IDEA 中配置文件头注释模板是提升代码规范性可读性的重要步骤。通过设置合适的注释模板,可以在新建类或文件时自动生成统一格式的头部注释信息,如作者、创建时间、文件描述等。 ### 配置路径与入口 首先,在 IntelliJ IDEA 中打开设置界面,可以通过菜单栏中的 `File` -> `Settings`(Windows 系统)或 `IntelliJ IDEA` -> `Preferences`(macOS 系统)进入设置窗口[^1]。随后导航至 `Editor` -> `Live Templates`,在此处可以创建或编辑用于生成文件头注释的模板。 ### 创建文件头注释模板 在 `Live Templates` 设置页面中,点击右侧的 `+` 按钮添加一个新的模板组(例如命名为 `MyCodeGroup`),然后再次点击 `+` 添加一个 Live Template[^2]。在 `Abbreviation` 输入框中填写触发该模板的缩写,例如 `cls`,在 `Description` 中输入简要说明,比如“Class Header Comment”。 在模板编辑区域输入如下内容作为示例: ```java /** * @author ${USER} * @date ${DATE} ${TIME} * @description ${DESCRIPTION} */ ``` 其中 `${USER}`、`${DATE}` `${TIME}` 是 IntelliJ IDEA 内置的变量,分别表示当前用户、日期时间;`${DESCRIPTION}` 可以手动输入或通过脚本自动填充[^3]。 ### 自定义参数实现 对于某些动态参数,如方法参数列表(param),IDEA 默认支持较弱,因此需要通过编写 Groovy 脚本来实现更智能的参数提取功能。例如,以下脚本可用于提取方法参数并生成对应的注释项: ```groovy def params = methodParameters params.collect { "@param $it.name $it.type.text" }.join("\n ") ``` 将上述脚本配置为模板表达式后,即可在生成方法注释时自动列出所有参数及其类型[^3]。 ### 应用范围设置 最后,在模板设置底部的 `Define` 区域选择适用的语言环境,如 Java 类或接口。完成所有配置后,点击 `Apply` 并保存设置。此时,在新建类文件时输入 `cls` 后按下回车键,即可快速生成预设的文件头注释模板[^2]。
评论 7
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值