前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >IDEA使用模板自动生成类注释和方法,解决方法注释在接口中或普通类的方法外使用模板注释不带参数的情况

IDEA使用模板自动生成类注释和方法,解决方法注释在接口中或普通类的方法外使用模板注释不带参数的情况

作者头像
全栈程序员站长
发布于 2022-09-27 02:48:30
发布于 2022-09-27 02:48:30
1.6K00
代码可运行
举报
运行总次数:0
代码可运行

大家好,又见面了,我是你们的朋友全栈君。

IDEA自动生成类注释和方法注释

类注释

按照下方路径打开设置

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
File->Settings->Editor->File and Code Templates->Includes->File Header

File Header代码

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/**
 * @author       ${USER}
 * @date         Created in ${DATE} ${TIME}
 * @modified By  ${USER} in ${DATE} ${TIME}
 * @description  AddDescriptionHere
 */

idea 模板使用的velocity模板语言,

velocity.apache.org

方法注释

File->Settings->Editor->Live Templates

1.创建模板组

2.创建对应模板

3.修改快捷键(缩略词)

  • 针对在接口中或普通类的方法外使用模板注释不带参数的情况
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
假如触发的快捷键为doc,
★在类中输入 "/doc" 触发方法注释可以带参数,
★但是下方的template text 开头要去掉"/"<br>
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
为了符合注释习惯,可以将快捷键设为 ***,
★在类中输入 /*或者/**可以触发带参数的方法注释
★对应的,在template text 开头要去掉 /或者/*
  • 相当于将快捷键替换为template text中的内容,很好理解

4.添加模板内容

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
**
 * $insert$ AddDescriptionHere
 * @author  $user$ 
 * @date    $date$ $time$
 * @param   $param$
 * @return  $return$
 */

5.添加关联文件(可以是Java,也可以全选) 6.编辑模板变量

  • param的脚本
  • return 也可以这样的脚本设置
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
groovyScript("   def result='';
                 def params=\"${ 
   _1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
                 for(i = 0; i < params.size(); i++) { 
   
                     if(i!=0)result+= ' * @param\\t';
                     result+= params[i] + ((i < (params.size() - 1)) ? '\\n': '');     
                 };     
              return result",
              methodParameters())

7.应用保存

参考: idea 自动生成类注释和方法注释的实现步骤-脚本之家 使用groovy脚本生成idea方法注释参数格式对齐

发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/179201.html原文链接:https://javaforall.cn

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
编辑精选文章
换一批
IntelliJ IDEA使用(一)基本设置与类、方法模板设置
其实之前一直开发都是在使用的是Eclipse,但是最近在做Maven项目的时候要用IntelliJ IDEA,据说这个idea功能非常的强大,最近在使用的时候发现如果适应的真的是非常的强大。感觉是比E
用户1195962
2018/01/18
3.2K0
IntelliJ IDEA使用(一)基本设置与类、方法模板设置
idea设置文件头注释_idea设置方法注释
类头注释:打开file->setting->Editor->Filr and Code Templates->Includes->File Header
全栈程序员站长
2022/09/27
1.4K0
idea设置文件头注释_idea设置方法注释
转引的注释怎么写_java注释模板
添加注释模板方法:CTRL+ALT+S(或者File -> Setting) 打开设置,搜索Live Templates 如下图一所示:
全栈程序员站长
2022/11/10
7K0
转引的注释怎么写_java注释模板
开发工具IDEA——增加注释快捷按键
开发工具IDEA系列文章是我在进行Java开发时使用IDEA开发工具一些设置和其调整,特将其整理出来分享给大家,特别适合于刚接触开发或者刚重新安装开发工具的小伙伴们,可以根据这一系列文章将IDEA工具调校成为自己的左膀右臂,助力自己的Java开发。
cn華少
2021/11/24
1.7K0
开发工具IDEA——增加注释快捷按键
idea文档注释设置_idea怎么设置注释模板
IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。
全栈程序员站长
2022/09/21
7.1K0
idea文档注释设置_idea怎么设置注释模板
IntelliJ IDEA Java注释模板最简单快捷设置操作图示
打开idea,选择File-settings-Editor-Live Templates
用户7886150
2021/04/21
4660
idea里面的注释模板
打开 IDEA 的 Settings,点击 Editor–>File and Code Templates,点击右边 File 选项卡下面的Class,在其中添加图中红框内的内容:
一写代码就开心
2022/05/09
1K0
idea里面的注释模板
idea Java 代码编写规范
1.阿里巴巴Java开发手册 ---- 2.基于上面的idea代码检查插件 打开idea file–>setting–>plugins–>Browse repositories… 搜索alibaba可以看到Alibaba Java Coding Guidelines 点击install安装 点击OK,然后重启idea 右键点击工程文件或目录可以看到 “编码规约扫描”、“关闭实时检测功能” 切换语言 Tools–>alibaba…./阿里…–>switch…/切换… ---- 3.设置类头注释 打开
qubianzhong
2018/09/19
1.9K0
IDEA自定义配置注释模板,让你看起来更加专业!!!
在以上的代码中我们可以看到只要创建一个类,idea自动会给你补充注释消息,有作者信息和创建时间 关于模板参数代码我已经放到下面了:
ma布
2024/10/21
7290
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA这样配置注释模板,让你帅到没朋友!!
打开 IDEA 的 Settings,点击 Editor-->File and Code Templates,点击右边 File 选项卡下面的 Class,在其中添加图中红框内的内容:
终码一生
2022/04/14
6410
IDEA这样配置注释模板,让你帅到没朋友!!
IDEA自动生成代码注释
4.编辑Live Template,在Template text中输入一下注释模板。
黑洞代码
2021/09/28
7.4K0
IDEA这样配置注释模板,让你高出一个逼格!!
打开 IDEA 的 Settings,点击 Editor-->File and Code Templates,点击右边 File 选项卡下面的 Class,在其中添加图中红框内的内容:
用户1516716
2021/03/24
4K0
IDEA这样配置注释模板,让你高出一个逼格!!
IDEA 设置类和方法注释模板
File -> Settings -> Editor -> File and Code Templates
Remember_Ray
2020/03/08
6810
idea 自定义注释
日常开发当中,开发规范要求每个开发人员做到要必要的代码上加上注释。借助IDE可以快速的生成这些注释。
潇洒
2023/10/20
4430
idea 自定义注释
idea 自定义注释
日常开发当中,开发规范要求每个开发人员做到要必要的代码上加上注释。借助IDE可以快速的生成这些注释。
潇洒
2019/07/03
2.1K0
Intellij IDEA 撸码最头大的问题。。
想栈长我当初从 Eclipse 转用 IDEA 真是纠结,放弃然后尝试了N次,不过现在已经算是转型成功了,可以完全脱离 Eclipse 撸码了,虽然说我现在真的撸得非常少了。。
Java技术栈
2019/05/17
1.4K0
Intellij IDEA 撸码最头大的问题。。
IDEA 注释详解[通俗易懂]
ctrl + alt + s (设置) –> Live Templates –> + 新建一个template group ,在group里面新建一个live templates Abbreviation: 填入/** (自定义快捷方式), Template text:填入模板信息
全栈程序员站长
2022/11/10
1K0
IDEA 注释详解[通俗易懂]
Intellij idea liveTemplate 方法注释之params,return参数自动获取
之前设置idea liveTemplate 方法注释的时候,按照网上的教程params,return参数无法获取,现在终于解决这个问题了,我将详细介绍配置的每一步。
挨踢小子部落阁
2023/03/15
1.6K0
Intellij idea liveTemplate 方法注释之params,return参数自动获取
IntelliJ IDEA生成live template(代码模板)
快捷键:Ctrl+Shift+A进入Find Action,输入live template
用户2409797
2019/02/25
1.9K0
IDEA设置自动生成注释模板
设置新建类注释模板 /** * @description * @author yh * @date ${DATE} */ public class ${NAME} { } 方法模板(也可在类上生成注释) groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i+
鱼找水需要时间
2023/02/16
8250
IDEA设置自动生成注释模板
相关推荐
IntelliJ IDEA使用(一)基本设置与类、方法模板设置
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
本文部分代码块支持一键运行,欢迎体验
本文部分代码块支持一键运行,欢迎体验