idea 方法注释 @param

 

idea中 设置 @param 以及@return的方法 网上有很多 我这里就写下我设置的时候遇到的问题

 

 

 

相信很多人都有遇到这样的问题 在方法里面注释可以能识别

在方法外面就识别不出参数了

 

主要是 模板的问题  很多教程上的模板

 

 

/**
 * @author YangJie 
 * @date $date$ $time$ 
 * @email [e-mail]
$params$
$return$
 * @Description
*/

 

 

这样的 /** 开头

如果模板里面有/**的话在方法外就识别不出参数来

就记住最主要的一点

设置模板的时候不要带  “/*”

我们把模板该一下 把/*去掉

改了以后的模板

 

使用/**的时候前面有/*  ide会把最后一个*替换成模板的内容

所以最后的结果还是

 

/** 
 * @author YangJie 

这样的

贴上我的代码

 

模板代码

 

*
 * @author YangJie 
 * @date $date$ $time$ 
 * @email [e-mail]
$params$
$return$
 * @Description
*/

 

 

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

 return：

 

 

groovyScript("def returnType = \"${_1}\"; def result = ' * @return : ' + returnType; return result;", methodReturnType());

 

 

 

这样使用/** + tab 就可以在方法外面获取到param了

 

 本猿的idea 版本是2018.3

 

 

后记：

我看网上很多教程都是把代码放在 expression 里面的

我这个版本放在expression里面不生效哈  放在defaultValue里面的

就像这样