Idea 设置类和方法的注释(获取参数)

本文介绍了如何在IntelliJIDEA(Idea)中创建和配置类注释及方法注释模板。通过File–Setting–Editor–FileandCodeTemplates可设置类注释,使用LiveTemplates功能能方便地生成带参数信息的方法注释。在LiveTemplates中设置groovyScript函数来格式化参数,以实现自动化的代码注释生成。

Idea 添加注释:类注释、方法注释
类注释
方法注释
类注释
File–Setting–Editor–File and Code Templates–Class:
注释模板:

/** 
 *
 *@description: 
 *@author: fqtang
 *@time: ${DATE} ${TIME}
 * 
 */

操作截图:

  效果:

 

方法注释

为了获取参数信息,我们需要使用 “ Live Templates” 。

创建 Live Templates 分组

File–Setting–Live Templates。

 

   创建 Template

我们上一步创建了 mymethod分组,现在我们将在 mymethod分组中创建 Template。

 设置模板内容

模板缩写(Abbreviation):例如,我们可以把它设置为 “a”。
模板描述(Description):例如,我们可以设置为 “方法注释”。
模板内容:

/**
 *
 * @description: 
 $params$
 * @return: $return$
 * @author: fqtang
 * @time: $date$ $time$
*/

网上基乎每篇blog都说不为"/**",但我操作下来测试生成的方法注释都是乱格式,很操蛋。如下图:

 我的配置如下:

 我们上一步的截图中,点击 Edit variables 按钮可以弹出变量设置窗口。

这里,我们把参数变量 params 设置为一个自定义函数 groovyScript() 。groovyScript 函数调用 Idea 的 methodParameters() 函数获得参数数组,并进行格式化。
params 的值(即 groovyScript 函数):

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' : '')}; return result", methodParameters())

其他变量的值,直接使用 Idea 的函数进行赋值。

date → date()
time → time()
return → methodReturnType()

效果:

 若大家在操作过程中有疑问,请留言。

### 配置 IntelliJ IDEA 中的 Java 方法注释模板 #### 创建自定义活码模板 (Live Templates) 为了在 IntelliJ IDEA 中配置 Java 方法注释模板,需通过创建自定义活码模板来实现。这可以通过进入设置菜单完成。 对于 Windows 用户,在 IDEA 主界面按下 `Ctrl + Alt + S` 打开设置窗口;而对于 Mac 用户,则可以使用快捷键 `Command + ,` 来访问相同的功能[^3]。 一旦进入了设置页面,导航至 `Editor -> Live Templates` 路径下。在此处能够看到多个预设好的代码片段以及用户自行添加的新条目。要新增一个用于自动填充注释的模板,点击右侧面板上的绿色加号按钮并选择 "Live Template"。 #### 定义具体的方法注释模板 当选择了 "Live Template" 后,会弹出一个新的对话框让用户填写必要的细节: - **Abbreviation**: 输入触发该模板时使用的缩写词,例如为方法注释设定为 `meth` 或者针对整个则可能是 `cls`。 - **Description**: 描述此模板的作用范围及其功能简介。 - **Template text**: 编辑实际想要插入到源文件里的文本内容。这里可以根据个人喜好调整格式化风格,并利用特殊占位符(如 `$PARAMETERS$`, `$RETURN_TYPE$` 等)来自动生成参数列表或其他上下文敏感的信息[^4]。 下面是一个简单的例子展示如何编写适用于大多数情况下的方法注释模板: ```text /** * ${DESCRIPTION} * * @param ${parameters} * @return ${returnType} */ ``` 其中 `${parameters}` 变量可通过 Groovy 表达式动态计算得出所有形参的名字与型组合而成的一串字符串。 同样地,如果希望给每一个新建立的 Java 都附带标准形式的头部说明文字,也可以按照上述流程操作一遍,只是这次应该把重点放在描述的目的、作者姓名以及其他元数据上。 #### 应用场景示例 假设现在有一个名为 `CalculatorService` 的服务层接口里包含了两个业务逻辑函数——一个是用来求两数之差 (`subtract`),另一个则是获取当前时间戳(`getCurrentTimestamp`)。那么借助于之前所定制过的 live template 就可以在 IDE 提示下快速写出如下所示的标准 Javadoc 形式的文档结构: ```java public interface CalculatorService { /** * 计算两个整数之间的差异. * * @param minuend 减数 * @param subtrahend 被减数 * @return 差值 */ int subtract(int minuend, int subtrahend); /** * 获取系统当前的时间戳毫秒表示法. * * @return 时间戳数值 */ long getCurrentTimestamp(); } ```
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值