首页 > 其他分享 >IDEA 利用groovy脚本生成注释

IDEA 利用groovy脚本生成注释

时间:2024-10-31 14:47:07浏览次数:3  
标签:groovy methodReturnType outputDesc IDEA 注释 result outputClassOtherInfo def

 

  • 介绍

 

本文主要介绍利用IDEA编辑器的活动模板,结合groovy脚本,生成注释模板。目前生成的注释主要适用于java和js文件

推荐此方式,可以根据需要定义groovy脚本,生成不同格式的注释

  • 操作

  • 点击 File >> Setting 

找到 Edtor >> Live Temolates , 建议创建一个模板组 java_often(非必须,创建一个好管理)

 

 

  • 再次点击+号,创建一个 Live Temolate

缩写Abbreviation处填写星号 * 

模板文本填写  **$context$ */  , 注意星号顶头填写,前面没有空格,变量context可自定义

 

  •  点击 Edit Variables

Name处填写 context ,注意对应上一步的变量

Expression处不可选择

Default value填写 

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脚本文件

def packageName = _1;
def className = _2;
def methodName = _3;
def jsMethodName = _4;
def methodParameters = _5;
def methodReturnType = _6;
def date = _7;
def time = _8;

def confirmedDateTimeString = "2022-03-01 12:20:40";
// 可以修改成自己的相关信息
def author = "mutouyang";
def projectName = "demoProject";
def version = "V1.0.0";
def copyright = "2017 mutouyang Inc. All rights reserved.";

if(packageName){
    String[] str = packageName.split("\\.")
    if(str.length >2){
        projectName=str[1];
    }
}

def outputParams = "";
for(param in methodParameters) {
    outputParams += " * @param " + param + " : \n";
}
def outputReturnType = "";
if (methodReturnType != null & methodReturnType != "void") {
    outputReturnType = " * @return : " + methodReturnType + "\n";
}

def outputMethodName         = " * method : " + methodName + "</br>\n";
def outputDesc               = " * description :     </br>\n";
if(!outputReturnType){
    //outputDesc             = " * description : 构造方法 </br>\n";
}
def outputAuthor             = " * @author : " + author + "</br>\n";
def outputDateTime           = " * @CreateDate : " + date + " " + time + "</br>\n";
def outputProjectName        = " * @Project : " + projectName +"</br>\n";
def outputPackageName        = " * @Package : " + packageName + "</br>\n";
def outputClass              = " * @ClassName : " + className + "</br>\n";
def outputVersion            = " * @version : " + version + "</br>\n";
def outputClassOtherInfo     = " * @Copyright : " + copyright + "</br>\n";
outputClassOtherInfo        += " * @Reviewed : " + "\n";
outputClassOtherInfo        += " * @UpateLog :    Name    Date    Reason/Contents\n";
outputClassOtherInfo        += " *             ---------------------------------------\n";
outputClassOtherInfo        += " *                ****    ****    **** \n";
def outputJsMethodName       = " * method : " + jsMethodName + "</br>\n";
def outputJsParams           = " * @param </br>\n";
def outputJsReturnType       = " * @return : </br>\n";

def result = "";

result += "\n";
if (methodName) {
    result += outputMethodName;
    result += outputDesc;
    result += outputParams;
    result += outputReturnType;
    result += outputAuthor;
    result += outputDateTime;
} else if (jsMethodName) {
    result += outputJsMethodName;
    result += outputDesc;
    result += outputJsParams;
    result += outputJsReturnType;
    result += outputAuthor;
    result += outputDateTime;
} else {
    result += outputProjectName;
//  result += outputPackageName;
    result += outputClass;
    result += outputDesc;
    result += outputAuthor;
    result += outputDateTime;
    result += outputVersion;
//  result += outputClassOtherInfo;
}
//result += " *";
return result;

 

标签:groovy,methodReturnType,outputDesc,IDEA,注释,result,outputClassOtherInfo,def
From: https://www.cnblogs.com/mutouyang/p/18517639

相关文章

  • 达梦客户端/idea连接达梦/达梦导出
    达梦自带的工具导出非常有缺陷大问题,所以使用idea连接达梦进行导出 一,下载达梦jdbc驱动达梦官网产品下载|达梦数据库(dameng.com)     二,idea添加driver在IntelliJIDEA中连接达梦数据库,可以按照以下步骤进行操作:1.打开IntelliJIDEA,进入项目。2.......
  • idea中怎么配置使用gitlab
    idea中配置使用gitlab的步骤:1.安装Git;2.在GitLab上创建项目;3.配置GitLab账户;4.导入或克隆GitLab项目;5.提交和推送更改;6.解决冲突和合并请求。首先,确保您的计算机上安装了Git。您可以从Git官方网站下载适用于您操作系统的Git版本并进行安装。1.安装Git首先,确保您的计算机上安......
  • 工作炒股两不误!这款 IDEA 插件帮助你关注股票&基金!
    大家好,我是Java陈序员。之前给大家安利过一款VSCode插件来实时查看股票&基金!韭菜盒子!VSCode也可以看股票&基金了!今天,给大家介绍一款同款的IDEA插件,在写代码的同时也能实时关注股票&基金!关注微信公众号:【Java陈序员】,获取开源项目分享、AI副业分享、超200本经典计算机......
  • CNN+迁移学习=中科院2区Idea!可以直接抄!
    2024深度学习发论文&模型涨点之——CNN+迁移学习CNN(卷积神经网络)是一种深度学习模型,广泛应用于图像识别、计算机视觉等领域。它通过局部连接和权值共享的机制,有效地捕捉图像中的特征,例如边缘、纹理等。迁移学习是一种机器学习技术,它允许一个预训练的模型被调整并应用于一个不......
  • 快速发论文idea:KAN+transformer,结合创新,效果翻倍。
    2024深度学习发论文&模型涨点之—KAN+TransformerKAN+Transformer是一种结合了Kolmogorov-ArnoldNetworks(KAN)和Transformer架构的新型神经网络模型。这种结合模型利用了KAN的灵活性和可解释性,以及Transformer的强大表示能力和序列处理能力,以提高复杂数据任务的效率和准确性。......
  • 关于测度理论相关术语的注释(啊终于接受了hh)
    最开始听拓扑课的时候,一直无法理解,明明看拓扑空间定义,\(\tau\)才是拓扑空间的根本,它包含基本集\(X\)构成了拓扑空间啊,为什么所有题目开头第一句“在拓扑空间X上”好,我告诉自己接受就好。后来测度空间,我的学习大头...\((X,\mathcal{M},\mu)\),多么直观和美妙的书写,一个基本集,一个......
  • IDEA设置语法高亮自动检查xml中sql语法
    1、首先如果使用的是终极版直接去SQLDialects里面设置就行。详细信息2、如果是社区版就没有这个功能,但如果可以自己安装MybatisCodeHelperPro插件idea中点File->Settings->Plugins,输入MyBatisCodeHelperPro点击安装即可,一年的费用是十来块;另外网上到处有魄姐教程不细说,用于......
  • idea从新建一个maven项目到打包成可运行jar包全流程供接口测试签名使用
     1创建maven项目点击new-project 选择左侧的mavenArchetype修改Name,JDK,Catalog,Archetype(org.apache.maven.archetypes:maven-archetype-webapp)为下图中配置 修改地址(自选),版本号(自选),之后点击create 2配置maven在settings中找到下图中maven的位置,并自定义maven包,......
  • IDEA如何在线安装一个插件,超简单
    前言我们在使用IDEA开发Java应用时,经常是需要安装插件的,这些各种各样的插件帮助我们快速的开发应用,今天,就来介绍下如何在IDEA中安装插件。那么,我们该如何安装插件呢?如何安装插件首先,我们打开设置面板。然后,我们点击【Plugins】,我们再在右侧点击【Marketplace】,在输入框里面......
  • 【IntelliJ IDEA】2024最新使用
    大家好!今天我非常高兴能够在这里与大家分享一份极具价值的资源——《IntelliJIDEA2024最新使用》。而IntelliJIDEA,作为业界领先的集成开发环境,以其强大的功能和出色的用户体验,成为了众多开发者的首选。这不仅包括其在代码编辑、调试、版本控制等方面的强大功能,还将涵盖如何......