网站菜单

IDEA配置类签名和方法签名

一、类签名

Idea提供了类文件的签名功能,在Idea设置中可以直接配置,如下图:

/**
 * @ClassName: ${NAME}
 * @Description:  TODO
 * @Author: runtian_song
 * @CreateDate: ${DATE} ${TIME}
 */

二、方法签名

1.基础配置

方法签名我们可以采用代码块模板功能来实现,为IDEA配置活动模板:

缩写:此处缩写为*,则输入*,再点击回车即可拉出整个代码块
描述:改代码块模板的描述
展开与:输入缩写之后再点击这个按钮展开代码块,默认为TAB,一般换为回车键ENTER
适用声明:我们应用在JAVA方法中,此处选择JAVA即可
按样式重新格式化:此处勾选该按钮,否则会出现换行缩进不统一

**
 * @Description: TODO 
 $params$
 * @return: $return$
 * @Author: runtian_song
 * @date: $date$ $time$
**/
注意:此处开头不要加反斜杠,否则在配置后续表达式会出现参数为null报错

2.变量配置

因为该模板并不是系统提供,所以需要为$*$包裹的参数进行配置
点击编辑变量,对使用到的每一个变量进行配置

此处的params进行自定义配置,是为了实现每一个params各占一行功能。
对return的配置,是为了添加@Link指向,修复return为空时注释报错。
代码如下:

//params:

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

//return

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())

配置到这里,就可以使用了,在代码的方法处,输入/*+回车就可以看到相应的效果。

相关推荐

  • * 暂无相关文章