android groovy 注解,IDEA自定义类注释和方法注释(自定义groovyScript方法实现多行参数注释)...

一、类注释

1、打开设置面板:file -> setting -> Editor -> file and code Templates

选择其中的inclues选项卡,并选择File header,如图。不要选择Files选项卡再设置Class,这样比较麻烦,而且这样设置以后没新建一个类都要自己写一次Date。

2、在右边编辑面板插入自己想要的注释即可。其中${}是变量,需要在变量基本都在编辑款下面的Description,往下拉即可看到。

/** @Classname ${NAME}

*

* @Date ${DATE}

*

* @userName*/

3、新建一个类,看是否自动加了注释

二、方法注释

1、打开设置面板:file -> setting -> Editor -> Live Templates

2、新建一个Template Group…,命名随意,假设为bokeyuan,然后选择该组,点击新建一个模板Live Template

3、名称建议设为*,文本框输入自己想要设置的注释格式,右下角要选择enter(原本是tab)。

4、留意注释格式,其中参数要直接写变量$param$,开头只有一个*号。写好之后点击上图框中的edit variables

其中返回值return使用系统自带的,下拉可以找到methodReturnType()

5、自定义多行参数注释

IDEA自带的参数函数methodParameters()产出的注释格式是这样的:

/***

*@param[a,b,c]

*@returnvoid

*@throws

*/

我们可能需要的是多行参数注释:

/***

*@parama

*@paramb

*@paramc

*@returnvoid

*@throws

*/

这个时候就要使用里面的groovyScript()函数来自定义格式:

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())

直接复制在Expression里面即可。

6、选择语言,点击Define勾选Java

有其他问题可以评论问我哦

### IntelliJ IDEA自定义方法注释 在 IntelliJ IDEA 中,可以通过配置文件模板来自定义方法注释。这有助于提高代码的一致性可读性。 #### 创建或编辑方法注释模板 进入 `File` -> `Settings` (Windows/Linux) 或者 `IntelliJ IDEA` -> `Preferences` (macOS),导航至 `Editor` -> `File and Code Templates` -> `Includes` -> `File Header` `Method Comment` 来创建或修改现有的注释模板[^1]。 对于方法级别的注释,通常会在 `Method Comment` 中设定特定格式: ```text /** * @Description: * @Param: * @return: * @Author: ${USER} * @Date: ${DATE} */ ``` 此模板将在每次创建新方法时自动应用,并填充作者名当前日期等预设变量[^2]。 #### 添加参数描述支持 为了让 IDE 自动生成更详细的文档说明,特别是针对函数入参部分的内容,可以在上述基础上进一步增强。通过 Groovy 脚本实现动态解析方法签名中的参数列表并将其转换成 Javadoc 形式的注解[^3]: ```groovy groovyScript("def result='';def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();def paramTypes=\"${_2}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param ' + paramTypes[i]+' '+params[i] + ((i < params.size() - 1) ? '\\n ' : '')}; return result", methodParameters(),methodParameterTypes) ``` 这段脚本能够遍历所有传入的方法参数及其类型,在生成的注释中逐项列出它们作为 `@param` 的一部分。 #### 应用场景调整 左下角选项允许指定该模板适用的具体上下文环境——例如仅限于 Java 类内的公共成员函数或是任意位置均可触发。这样可以根据实际需求灵活控制何时启用这些定制化的注释样式。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值