idea开发工具怎么给方法添加带参数和返回值的注释

最新推荐文章于 2023-11-14 16:05:45 发布

原创最新推荐文章于 2023-11-14 16:05:45 发布 · 4.3k 阅读

0 ·

CC 4.0 BY-SA版权

Java 专栏收录该内容

55 篇文章

订阅专栏

本文解析了IDE中模板方法的工作原理，特别关注了方法内部的作用域问题。解释了为何某些内置方法如user()和date()可以在文件模板中直接使用，而与特定方法相关的方法如methodName()仅在方法体内有效。此外，还提供了如何利用groovyScript实现多参数换行展示的技巧。

不知道怎样可以带回参数和返回值等信息，但是我知道为啥不显示了。

user()和date()能显示内容，是因为这两个方法在其有效的作用域执行。

而关于Method的方法（如methodName()、methodParameters()、methodReturnType()）没有起作用是因为你在方法外执行的mc快捷操作，这些方法的作用域是在方法内。

看下methodName()方法的解释：Returns the name of the embracing method (where the template is expanded).返回起作用的方法的名称。

This is a built-in template. It contains a code fragment that can be included into file templates (Templates tab) with the help of the #parsedirective.
The template is editable. Along with static text, code and comments, you can also use predefined variables that will then be expanded like macros into the corresponding values.

Predefined variables will take the following values:
${PACKAGE_NAME}		name of the package in which the new file is created
${USER}		current user system login name
${DATE}		current system date
${TIME}		current system time
${YEAR}		current year
${MONTH}		current month
${MONTH_NAME_SHORT}		first 3 letters of the current month name. Example: Jan, Feb, etc.
${MONTH_NAME_FULL}		full name of the current month. Example: January, February, etc.
${DAY}		current day of the month
${HOUR}		current hour
${MINUTE}		current minute
${PROJECT_NAME}		the name of the current project

注意点二：多个参数换行，可以使用 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\\b' : '')}; return result", methodParameters())