java 类方法自定义说明注解

原创已于 2022-01-28 17:25:00 修改 · 687 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发语言 #后端

于 2022-01-28 17:24:14 首次发布

本文介绍了一种自动生成代码注释的方法，包括类注释和方法注释的自动生成过程。通过配置模板变量，可以自动填充作者、日期等信息，并能根据方法参数生成对应的@param注释。

类自动生成注释说明

添加: ${USER} ==小乌龟都可以

/**
 * @Description  TODO
 * @Author  ${USER}
 * @Date  ${DATE} ${TIME}
 */

展示结果

/**
 * @Description TODO
 * @Author 小乌龟
 * @Date 2022/1/28 17:16
 */
public class a {
}

方法注释说明

5.设置模板

*
  *@MethodDescription: 
 $params$
  * @return $returns$
  * @author 小乌龟
  * @date $date$ $time$
  */

6.模板变量配置

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 result=''; 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())

总图参考

运用: /**+enter

   /**
      *@MethodDescription: 
      * @param article
      * @return Results
      * @author zhangjunrong
      * @date 2022/1/28 17:17
      */
    Results saveArticle(SaveArticleRo article);