Idea 添加注释:类注释方法注释(可获取参数)

Posted wsy0202

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Idea 添加注释:类注释方法注释(可获取参数)相关的知识,希望对你有一定的参考价值。

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

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

操作截图:

技术图片

 

 效果:

技术图片

 

 方法注释

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

创建 Live Templates 分组

File–Setting–Live Templates。

技术图片

 

技术图片

 

  创建 Template

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

技术图片

 

 设置模板内容

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

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

技术图片

 

 定义模板的使用范围

技术图片

 

 技术图片

 

 定义模板内容中引用的变量

 

 我们上一步的截图中,点击 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()

效果:

技术图片

 

 技术图片

 

 技术图片

 

以上是关于Idea 添加注释:类注释方法注释(可获取参数)的主要内容,如果未能解决你的问题,请参考以下文章

idea为方法添加自定义注释,param参数选择啥类型

idea中,sql注释改为<!---->

IDEA 利用注释模板添加注释;IDEA为方法类自动添加注释;IDEA添加注释的快捷键

IDEA 利用注释模板添加注释;IDEA为方法类自动添加注释;IDEA添加注释的快捷键

IDEA 利用注释模板添加注释;IDEA为方法类自动添加注释;IDEA添加注释的快捷键

idea添加类注释和方法注释