浅谈idea live template高级知识_进阶(给方法,类,js方法添加注释)

为了解决用一个命令(宏)给方法,类,js方法添加注释,经过几天的研究.终于得到结果了。

实现的效果如下：

给Java中的method添加方法：

/**
   *
   * @Method : addMenu
   * @Description :
   * @param menu :
   * @return : cn.yiyizuche.common.base.ResultMsg
   * @author : Rush.D.Xzj
   * @CreateDate : 2017-06-12 星期一 18:17:42
   *
   */public ResultMsg addMenu(Menu menu){
    ResultMsg result = null;
    return result;
  }

给 Java class 添加注释：

/**
 *
 * @Project : 壹壹OA
 * @Package : cn.yiyizuche.common.ou.menu.controller
 * @Class : MenuController
 * @Description :
 * @author : Rush.D.Xzj
 * @CreateDate : 2017-06-12 星期一 18:15:32
 * @version : V1.0.0
 * @Copyright : 2017 yizukeji Inc. All rights reserved.
 * @Reviewed :
 * @UpateLog :  Name  Date  Reason/Contents
 *       ---------------------------------------
 *         ***    ****  ****
 *
 */
public class MenuController {
}

给js 的方法添加注释

/**
 *
 * @Method : standardShowBatchCheckBox
 * @Description :
 * @return :
 * @author : Rush.D.Xzj
 * @CreateDate : 2017-06-12 星期一 18:15:21
 *
 */
function standardShowBatchCheckBox(jspElement, dataList, max, valueIdFunction, textFunction, selectedFunction) {
}

现在把答案公布如下

Abbreviation：

cmj

Template text(注1)：

**
 *$context$ 
 */

Edit variables：

$context$的代码(主要代码)如下:

groovyScript("def methodName = \"${_1}\"; def jsMethodName = \"${_2}\"; def outputMethodName = \"${_3}\"; def outputDesc = \"${_4}\"; def outputParams = \"${_5}\"; def outputAuthor = \"${_6}\"; def outputReturnType = \"${_7}\"; def outputDateTime = \"${_8}\"; def outputPackage = \"${_9}\"; def outputClass = \"${_10}\"; def outputClassOtherInfo = \"${_11}\"; def outputProject = \"${_12}\"; def outputVersion = \"${_13}\"; def outputJsMethodName = \"${_14}\"; def outputJsReturnType = \"${_15}\"; def result = ''; if (methodName != 'null') { result += '\\n'; result += outputMethodName; result += outputDesc; result += outputParams; result += outputReturnType; result += outputAuthor; result += outputDateTime; result += ' *'; return result;} else if (jsMethodName != 'null') { result += '\\n'; result += outputJsMethodName; result += outputDesc; result += outputJsReturnType; result += outputAuthor; result += outputDateTime; result += ' *'; return result;} else { result += '\\n'; result += outputProject; result += outputPackage; result += outputClass; result += outputDesc; result += outputAuthor; result += outputDateTime; result += outputVersion; result += outputClassOtherInfo; result += ' *'; return result;} ", methodName(), jsMethodName(), groovyScript("def methodName = \"${_1}\"; def result = ' * @Method : ' + methodName + '\\n'; return result;", methodName()), groovyScript("def result = ' * @Description : ' + '\\n'; return result;"), groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ' : ' + '\\n'}; return result;}", methodParameters()), groovyScript("def author = 'Rush.D.Xzj'; def result = ' * @author : ' + author + '\\n'; return result;"), groovyScript("def returnType = \"${_1}\"; def result = ' * @return : ' + returnType + '\\n'; return result;", methodReturnType()), groovyScript("def date = \"${_1}\"; def time = \"${_2}\"; def result = ' * @CreateDate : ' + date + ' ' + time + '\\n'; return result;", date("yyyy-MM-dd E"), time("HH:mm:ss")), groovyScript("def currentPackage = \"${_1}\"; def result = ' * @Package : ' + currentPackage + '\\n'; return result;", currentPackage()), groovyScript("def className = \"${_1}\"; def result = ' * @Class : ' + className + '\\n'; return result;", className()), groovyScript("def result = ' * @Copyright : 2017 yizukeji Inc. All rights reserved.' + '\\n'; result += ' * @Reviewed : ' + '\\n'; result += ' * @UpateLog :  Name  Date  Reason/Contents' + '\\n'; result += ' *       ---------------------------------------' + '\\n'; result += ' *         ***    ****  **** ' + '\\n'; return result;"), groovyScript("def result = ' * @Project : 壹壹OA' + '\\n'; return result;"), groovyScript("def result = ' * @version : V1.0.0' + '\\n'; return result;"), groovyScript("def jsMethodName = \"${_1}\"; def result = ' * @Method : ' + jsMethodName + '\\n'; return result;", jsMethodName()), groovyScript("def result = ' * @return : ' + '\\n'; return result;"))

使用如下：

在xx.java或者 xx.js中输出(注2)：

/cmj

后 按 tab键(此键是默认的,可以更改成其他的)

注1 和注2

也可以换成第二种方法(网上大部分的方法):

Template text

*
 *$context$ 
 */

跟注1比较第一行少了一个*,

因此注2就是变成了：

/*cmj

我感觉用我的方法比第二种方法好。

Edit Variable中代码详解

首先我分解了如下的 10几个函数(是小函数)：

// 输出方法名
  groovyScript("def methodName = \"${_1}\"; def result = ' * @Method : ' + methodName + '\\n'; return result;", methodName())
  
  // 输出描述
  groovyScript("def result = ' * @Description : ' + '\\n'; return result;")
  
  // 输出参数列表的子函数
  groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ' : ' + '\\n'}; return result;}", methodParameters())
  
  // 输出  作者的    子函数 这里可以改作者
  groovyScript("def author = 'Rush.D.Xzj'; def result = ' * @author : ' + author + '\\n'; return result;")
  
  // 输出  返回值的  子函数
  groovyScript("def returnType = \"${_1}\"; def result = ' * @return : ' + returnType + '\\n'; return result;", methodReturnType())
  
  // 输出  日期的   字函数, 这个可以更改日期格式
  groovyScript("def date = \"${_1}\"; def time = \"${_2}\"; def result = ' * @CreateDate : ' + date + ' ' + time + '\\n'; return result;", date("yyyy-MM-dd E"), time("HH:mm:ss"))

  // 输出Project
  groovyScript("def result = ' * @Project : 壹壹OA' + '\\n'; return result;")
  
  // 输出package
  groovyScript("def currentPackage = \"${_1}\"; def result = ' * @Package : ' + currentPackage + '\\n'; return result;", currentPackage())
  
  // 输出class
  groovyScript("def className = \"${_1}\"; def result = ' * @Class : ' + className + '\\n'; return result;", className())
  
  // 输出copyright/reviewd/updatelog
  groovyScript("def result = ' * @Copyright : 2017 yizukeji Inc. All rights reserved.' + '\\n'; result += ' * @Reviewed : ' + '\\n'; result += ' * @UpateLog :  Name  Date  Reason/Contents' + '\\n'; result += ' *       ---------------------------------------' + '\\n'; result += ' *         ***    ****  **** ' + '\\n'; return result;")
  
  // 输出version
  groovyScript("def result = ' * @version : V1.0.0' + '\\n'; return result;")

  // 输出jsMethodName
  groovyScript("def jsMethodName = \"${_1}\"; def result = ' * @Method : ' + jsMethodName + '\\n'; return result;", jsMethodName())
  
  // 输出 js 的return
  groovyScript("def result = ' * @return : ' + '\\n'; return result;")

然后在主要代码中,需要把上述的10几个函数当做参数供给主要代码使用.

判断是函数,类,js函数主要是通过如下的2个内置变量来实现的；

methodName()
jsMethodName()

当methodName()不为空的时候, 生成 方法的 注释

当jsMethodName()不为空的时候, 生成 js方法的注释

否则生成类的注释

所以上述的代码可以简单的做如下的归类了：

获取相关参数：

def methodName = \"${_1}\"; 
  def jsMethodName = \"${_2}\"; 
  def outputMethodName = \"${_3}\"; 
  def outputDesc = \"${_4}\"; 
  def outputParams = \"${_5}\"; 
  def outputAuthor = \"${_6}\"; 
  def outputReturnType = \"${_7}\"; 
  def outputDateTime = \"${_8}\"; 
  def outputPackage = \"${_9}\"; 
  def outputClass = \"${_10}\"; 
  def outputClassOtherInfo = \"${_11}\"; 
  def outputProject = \"${_12}\"; 
  def outputVersion = \"${_13}\"; 
  def outputJsMethodName = \"${_14}\"; 
  def outputJsReturnType = \"${_15}\"; 
  def result = '';

判断是哪一种类型的注释(代码片段2)：

if (methodName != 'null') {
    result += '\\n';
    result += outputMethodName;
    result += outputDesc;
    result += outputParams;
    result += outputReturnType;
    result += outputAuthor;
    result += outputDateTime;
    result += ' *';
    return result;
  } else if (jsMethodName != 'null') {
    result += '\\n';
    result += outputJsMethodName;
    result += outputDesc;
    result += outputJsReturnType;
    result += outputAuthor;
    result += outputDateTime;
    result += ' *';
    return result;
  } else {
    result += '\\n';
    result += outputProject;
    result += outputPackage;
    result += outputClass;
    result += outputDesc;
    result += outputAuthor;
    result += outputDateTime;
    result += outputVersion;
    result += outputClassOtherInfo;
    result += ' *';
    return result;
  }

这下就可以了.就把整个这么难看(groopscript搞的?)代码整理的比较清晰了.

我还有如下的几个疑惑/问题需要解决, 如果有朋友能给我答案那就好了.

问题1. 不知道可以通过什么方法获取js方法中的参数列表

问题2. 代码片段2中如果我改成了:

result += '\\n';
  if (methodName != 'null') {
    result += outputMethodName;
    result += outputDesc;
    result += outputParams;
    result += outputReturnType;
    result += outputAuthor;
    result += outputDateTime;
  } else if (jsMethodName != 'null') {
    result += '\\n';
    result += outputJsMethodName;
    result += outputDesc;
    result += outputJsReturnType;
    result += outputAuthor;
    result += outputDateTime;
  } else {
    result += '\\n';
    result += outputProject;
    result += outputPackage;
    result += outputClass;
    result += outputDesc;
    result += outputAuthor;
    result += outputDateTime;
    result += outputVersion;
    result += outputClassOtherInfo;
  }
  result += ' *';
  return result;

会出现如下的错误：

startup failed:
Script1.groovy: 1: expecting EOF, found 'result' @ line 1, column 1036.
  lt += outputClassOtherInfo; } result += 
                 ^
error

问题3：不知道怎么获取Override方法对应的接口方法(父类方法)

关于问题3: 实际上给这种方法加注释是没有意义的，具体可以参考： https://stackoverflow.com/questions/4310858/comments-on-overridden-method-in-java

但是如果非要加该怎么去判断.

以上这篇浅谈idea live template高级知识_进阶(给方法,类,js方法添加注释)就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持。

# idea  # live  # template  # IDEA添加Java类注释模版的方法  # IDEA创建方法时如何快速添加注释  # idea如何添加文档注释  # idea中创建新类时自动添加注释的实现  # 几个  # 给大家  # 种方法  # 子函数  # 为空  # 进阶  # 好了  # 我还  # 那就  # 几天  # 其他的  # 可以通过  # 希望能  # 就把  # 少了  # 这下  # 非要  # 这篇  # 能给  # 该怎么 

相关文章： ,购物网站怎么盈利呢？  企业在线网站设计制作流程,想建设一个属于自己的企业网站，该如何去做？  深圳网站制作费用多少钱,读秀，深圳文献港这样的网站很多只提供网上试读，但有些人只要提供试读的文章就能全篇下载，这个是怎么弄的？  公司门户网站制作公司有哪些,怎样使用wordpress制作一个企业网站？  MySQL查询结果复制到新表的方法(更新、插入)  网站好制作吗知乎,网站开发好学吗？有什么技巧？  C++如何将C风格字符串（char*）转换为std::string？（代码示例）  Thinkphp 中 distinct 的用法解析  如何通过远程VPS快速搭建个人网站？  如何自定义建站之星模板颜色并下载新样式？  建站之星CMS五站合一模板配置与SEO优化指南  个人摄影网站制作流程,摄影爱好者都去什么网站？  制作网站的网址是什么,请问后缀为.com和.com.cn还有.cn的这三种网站是分别是什么类型的网站？  北京网页设计制作网站有哪些,继续教育自动播放怎么设置？  哈尔滨网站建设策划,哈尔滨电工证查询网站？  建站之星后台密码遗忘？如何快速找回？  专业网站制作企业网站,如何制作一个企业网站，建设网站的基本步骤有哪些？  海南网站制作公司有哪些,海口网是哪家的？  如何选择CMS系统实现快速建站与SEO优化？  高防服务器：AI智能防御DDoS攻击与数据安全保障  如何通过可视化优化提升建站效果？  深圳网站制作培训,深圳哪些招聘网站比较好？  html制作网站的步骤有哪些,iapp如何添加网页？  如何确保FTP站点访问权限与数据传输安全？  青浦网站制作公司有哪些,苹果官网发货地是哪里？  建站主机空间推荐 高性价比配置与快速部署方案解析  如何在Windows 2008云服务器安全搭建网站？  如何构建满足综合性能需求的优质建站方案？  制作网站软件推荐手机版,如何制作属于自己的手机网站app应用？  表情包在线制作网站免费,表情包怎么弄？  广州顶尖建站服务：企业官网建设与SEO优化一体化方案  头像制作网站在线制作软件,dw网页背景图像怎么设置？  儿童网站界面设计图片,中国少年儿童教育网站-怎么去注册？  ,怎么用自己头像做动态表情包？  清单制作人网站有哪些,近日“兴风作浪的姑奶奶”引起很多人的关注这是什么事情？  公司网站建设制作费用,想建设一个属于自己的企业网站，该如何去做？  ui设计制作网站有哪些,手机UI设计网址吗？  制作企业网站建设方案,怎样建设一个公司网站？  关于BootStrap modal 在IOS9中不能弹出的解决方法(IOS 9 bootstrap modal ios 9 noticework)  广东专业制作网站有哪些,广东省能源集团有限公司官网？  番禺网站制作公司哪家值得合作,番禺图书馆新馆开放了吗？  高防服务器如何保障网站安全无虞？  建站之星安装失败：服务器环境不兼容？  ,如何利用word制作宣传手册？  网站制作公司广州有几家,广州尚艺美发学校网站是多少？  Android自定义listview布局实现上拉加载下拉刷新功能  建站之星微信建站一键生成小程序+多端营销系统  网站规划与制作是什么,电子商务网站系统规划的内容及步骤是什么？  东莞专业网站制作公司有哪些,东莞招聘网站哪个好？  建站VPS推荐：2025年高性能服务器配置指南