IDEA 快速生成文档注释并附带返回值教程(保姆级教程)

废话不多说直接看完成后的样子:

现在跟我做:

先从库里找到并且安装 kdoc-generator 插件

打开设置填写如下内容,注意看仔细了右边的设置和下面的设置,要和我完全一致.

右上角小加号,先点第二个创建模板组,随便命名,再点第二个创建模板,名字一定要跟我下面的截图一样
右下角的展开方式为 Enter

不想手写就复制下面的,自己把名字改了.

*
 * $name$
 * @return $return$
 * @author XXX
 * @create $date$
 * $param$
 **/

然后在右侧编辑变量那里,如下填写表达式

param的表达式为,自己复制.其他照抄.

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '') return result;if(i==0) result += '\\n'; result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())  

2024.7.10优化了一版表达式

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '') return result;if(i==0) result += '\\n'; result+='   * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())  

方法上/**+回车,成功了来点个赞吧!