IDEA生成类的和方法的注释(亲测)

本方法主要为java所用,其他的可借鉴

目录

1. 生成类的注释
2. 生成方法的注释
3. 用得到得参数

不了解的从头开始看,已经知道操作步骤的直接跳转到最后一条用得到的参数进行复制

1.生成类的注释

依照下图操作即可

2.生成方法的注释

生成方法的注释没有生成类的那么方便,我们需要自定义 templates 模板
第一步进入live templates 步骤如下图

输入自定义的模板文件夹名称
这里我起名叫MyTem

然后进行如下操作创建模板

创建模板后根据下图进行编辑

模板内容:

**
 * $description$$params$$return$
 * @author ljk
 * @since $date$ $time$
 */

注意:开头一定不能有’/’ 不然无法解析到变量和返回值

操作完后点击上方图片中解释两个字下面的 Edit variables键进入模板变量编辑
具体操作如下图

变量内容:

params:
groovyScript("def result='';def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i == 0 &&(params[i]==''|| params[i]=='null')){break};result+='\\n * @param '+params[i]+' '};return result", methodParameters())
return:
groovyScript("if(\"${_1}\"=='void'||\"${_1}\"=='null'){return ''};def result='\\n\t * @return ';def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList();for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};def p1=params[i].split(',').toList();for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}};};return result+' '", methodReturnType())
date:
date()
time:
time()

填写完后点击 [OK]
进行下图的操作:

选好后保存点击OK ,配置结束
实际效果
生成前

生成后:

可能用到的参数

模板内容:
update 2021-04-13 更新为带p标签的
update 2021-11-30 @date 不属于javadoc替换为 @since

**
 * <p>
 *  $description$
 * </p>$params$$return$
 * @author ljk
 * @since $date$ $time$
 */

注意:开头一定不能有’/’ 不然无法解析到变量和返回值
变量内容:

params:
groovyScript("def result='';def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i == 0 &&(params[i]==''|| params[i]=='null')){break};result+='\\n * @param '+params[i]+' '};return result", methodParameters())
return:
groovyScript("if(\"${_1}\"=='void'||\"${_1}\"=='null'){return ''};def result='\\n\t * @return ';def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList();for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};def p1=params[i].split(',').toList();for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}};};return result+' '", methodReturnType())
date:
date()
time:
time()