ToB企服应用市场:ToB评测及商务社交产业平台

标题: IDEA 使用groovy脚本天生注释 [打印本页]
作者: 王柳    时间: 2024-10-31 13:53
标题: IDEA 使用groovy脚本天生注释
 
 
本文主要介绍使用IDEA编辑器的活动模板，结合groovy脚本，天生注释模板。现在天生的注释主要适用于java和js文件
推荐此方式，可以根据需要界说groovy脚本，天生不同格式的注释
找到 Edtor >> Live Temolates ， 发起创建一个模板组 java_often（非必须，创建一个好管理）

 
 
缩写Abbreviation处填写星号 * 
模板文本填写  **$context$ */  ， 留意星号顶头填写，前面没有空格，变量context可自界说

 
Name处填写 context ，留意对应上一步的变量
Expression处不可选择
Default value填写 
  1. groovyScript("D:\\idea\\javadoc.groovy", currentPackage(), className(), methodName(), jsMethodName(), methodParameters(), methodReturnType(), date("yyyy-MM-dd"), time("HH:mm:ss"))
复制代码
由于需要的groovy脚本过长，所以创建了一个文件，这个文件发起跟idea安装目次放一起，文件内容放到了文章结尾

 
设置触发键 Enter 。
选择适用文件 java，

 
在Java类名输入 /* ，点击回车，即可生产注释，

 

 
 
groovy脚本文件
  1. def packageName = _1;
  2. def className = _2;
  3. def methodName = _3;
  4. def jsMethodName = _4;
  5. def methodParameters = _5;
  6. def methodReturnType = _6;
  7. def date = _7;
  8. def time = _8;
  10. def confirmedDateTimeString = "2022-03-01 12:20:40";
  11. // 可以修改成自己的相关信息
  12. def author = "mutouyang";
  13. def projectName = "demoProject";
  14. def version = "V1.0.0";
  15. def copyright = "2017 mutouyang Inc. All rights reserved.";
  17. if(packageName){
  18.     String[] str = packageName.split("\\.")
  19.     if(str.length >2){
  20.         projectName=str[1];
  21.     }
  22. }
  24. def outputParams = "";
  25. for(param in methodParameters) {
  26.     outputParams += " * @param " + param + " : \n";
  27. }
  28. def outputReturnType = "";
  29. if (methodReturnType != null & methodReturnType != "void") {
  30.     outputReturnType = " * @return : " + methodReturnType + "\n";
  31. }
  33. def outputMethodName         = " * method : " + methodName + "</br>\n";
  34. def outputDesc               = " * description :     </br>\n";
  35. if(!outputReturnType){
  36.     //outputDesc             = " * description : 构造方法 </br>\n";
  37. }
  38. def outputAuthor             = " * @author : " + author + "</br>\n";
  39. def outputDateTime           = " * @CreateDate : " + date + " " + time + "</br>\n";
  40. def outputProjectName        = " * @Project : " + projectName +"</br>\n";
  41. def outputPackageName        = " * @Package : " + packageName + "</br>\n";
  42. def outputClass              = " * @ClassName : " + className + "</br>\n";
  43. def outputVersion            = " * @version : " + version + "</br>\n";
  44. def outputClassOtherInfo     = " * @Copyright : " + copyright + "</br>\n";
  45. outputClassOtherInfo        += " * @Reviewed : " + "\n";
  46. outputClassOtherInfo        += " * @UpateLog :    Name    Date    Reason/Contents\n";
  47. outputClassOtherInfo        += " *             ---------------------------------------\n";
  48. outputClassOtherInfo        += " *                ****    ****    **** \n";
  49. def outputJsMethodName       = " * method : " + jsMethodName + "</br>\n";
  50. def outputJsParams           = " * @param </br>\n";
  51. def outputJsReturnType       = " * @return : </br>\n";
  53. def result = "";
  55. result += "\n";
  56. if (methodName) {
  57.     result += outputMethodName;
  58.     result += outputDesc;
  59.     result += outputParams;
  60.     result += outputReturnType;
  61.     result += outputAuthor;
  62.     result += outputDateTime;
  63. } else if (jsMethodName) {
  64.     result += outputJsMethodName;
  65.     result += outputDesc;
  66.     result += outputJsParams;
  67.     result += outputJsReturnType;
  68.     result += outputAuthor;
  69.     result += outputDateTime;
  70. } else {
  71.     result += outputProjectName;
  72. //  result += outputPackageName;
  73.     result += outputClass;
  74.     result += outputDesc;
  75.     result += outputAuthor;
  76.     result += outputDateTime;
  77.     result += outputVersion;
  78. //  result += outputClassOtherInfo;
  79. }
  80. //result += " *";
  81. return result;
复制代码
 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4