浅谈idea live template高级知识_进阶(给方法,类,js方法添加注释)
发布时间 - 2026-01-11 01:51:10 点击率：次为了解决用一个命令(宏)给方法,类,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中创建新类时自动添加注释的实现
# 几个
# 给大家
# 种方法
# 子函数
# 为空
# 进阶
# 好了
# 我还
# 那就
# 几天
# 其他的
# 可以通过
# 希望能
# 就把
# 少了
# 这下
# 非要
# 这篇
# 能给
# 该怎么
相关栏目：
【
网站优化151355 】
【
网络推广146373 】
【
网络技术251813 】
【
AI营销90571 】
相关推荐：
Laravel怎么实现API接口鉴权_Laravel Sanctum令牌生成与请求验证【教程】
Laravel Fortify是什么，和Jetstream有什么关系
JavaScript如何实现倒计时_时间函数如何精确控制
如何在云虚拟主机上快速搭建个人网站？
iOS发送验证码倒计时应用
Laravel怎么配置自定义表前缀_Laravel数据库迁移与Eloquent表名映射【步骤】
如何挑选高效建站主机与优质域名？
Laravel如何实现数据库事务？（DB Facade示例）
laravel服务容器和依赖注入怎么理解_laravel服务容器与依赖注入解析
Laravel如何处理表单验证？（Requests代码示例）
Laravel怎么使用Session存储数据_Laravel会话管理与自定义驱动配置【详解】
Laravel storage目录权限问题_Laravel文件写入权限设置
公司门户网站制作流程,华为官网怎么做？
如何在Ubuntu系统下快速搭建WordPress个人网站？
Laravel路由怎么定义_Laravel核心路由系统完全入门指南
laravel怎么通过契约（Contracts）编程_laravel契约（Contracts）编程方法
Windows家庭版如何开启组策略(gpedit.msc)？（安装方法）
Win11怎么查看显卡温度 Win11任务管理器查看GPU温度【技巧】
QQ浏览器网页版登录入口 个人中心在线进入
Laravel如何实现邮件验证激活账户_Laravel内置MustVerifyEmail接口配置【步骤】
Laravel distinct去重查询_Laravel Eloquent去重方法
Laravel如何实现多语言支持_Laravel本地化与国际化(i18n)配置教程
php嵌入式断网后怎么恢复_php检测网络重连并恢复硬件控制【操作】
html5如何实现懒加载图片_ intersectionobserver api用法【教程】
如何在自有机房高效搭建专业网站？
公司网站制作价格怎么算,公司办个官网需要多少钱？
移动端手机网站制作软件,掌上时代，移动端网站的谷歌SEO该如何做？
原生JS实现图片轮播切换效果
如何为不同团队 ID 动态生成多个独立按钮
美食网站链接制作教程视频,哪个教做美食的网站比较专业点？
作用域操作符会触发自动加载吗_php类自动加载机制与::调用【教程】
uc浏览器二维码扫描入口_uc浏览器扫码功能使用地址
Laravel如何处理异常和错误？（Handler示例）
Laravel怎么实现微信登录_Laravel Socialite第三方登录集成
Laravel如何使用Socialite实现第三方登录？（微信/GitHub示例）
湖南网站制作公司,湖南上善若水科技有限公司做什么的？
微信小程序制作网站有哪些,微信小程序需要做网站吗？
Laravel如何优化应用性能？（缓存和优化命令）
免费网站制作appp,免费制作app哪个平台好？
高性能网站服务器配置指南：安全稳定与高效建站核心方案
桂林网站制作公司有哪些,桂林马拉松怎么报名？
Laravel如何实现多表关联模型定义_Laravel多对多关系及中间表数据存取【方法】
Mybatis 中的insertOrUpdate操作
Bootstrap CSS布局之列表
Win11关机界面怎么改_Win11自定义关机画面设置【工具】
Laravel广播系统如何实现实时通信_Laravel Reverb与WebSockets实战教程
Laravel怎么实现搜索高亮功能_Laravel结合Scout与Algolia全文检索【实战】
Java解压缩zip - 解压缩多个文件或文件夹实例
个人摄影网站制作流程,摄影爱好者都去什么网站？
软银砸40亿美元收购DigitalBridge 强化AI资料中心布局
下一篇：远程操控电脑配置查看
下一篇：远程操控电脑配置查看