IDEA生成带参数和返回值注释
步骤说明
打开IDEA进入点击左上角 - 文件 - 设置 - 编辑器 - 活动模板
新建活动模板
填写模板文本
编辑变量
添加变量表达式
设置模板使用范围-设置全部范围应用-或者设置只在Java代码中使用等(看到最后)
打开IDEA进入 - 设置 - 编辑器 - 活动模板
选择Live Template 新建一个模板---或者选择下面一个Template Group 新建一个模板组在这个模板组下面再次点击Live Template 新建模板、填写模板文本----模板文本如下(可自行增删改):
**
* $param$
* @return $return$
* @date $date$ $time$
* @description $description$
*/
- 看图填空---缩写可自行定义这就是你调出这个注释的快捷键 , 我就按一般形式写的
**
, 这里我设置了参数、返回值、时间、描述四个值,模板文本上图已提供
- 点击上图中的编辑变量
- 其他的值对应的表达式照着填即可 , 以下是
return
、param
的表达式(注意:上图中return表达式返回的是全类名导致返回值过长--不建议使用、下面已提供return的表达式)
- return表达式:
groovyScript("
def result='';
def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList();
for(i = 0; i < params.size(); i++) {
if(i!=0){
result+='<';
};
def p1=params[i].split(',').toList();
for(i2 = 0; i2 < p1.size(); i2++) {
def p2=p1[i2].split('\\\\.').toList();
result+=p2[p2.size()-1];
if(i2!=p1.size()-1){
result+=','
}
} ;
};
return result", methodReturnType())
- param表达式:
groovyScript("
def result='';
def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();
for(i = 0; i < params.size(); i++) {
if(i!=0)result+= ' * ';
result+='@param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n' : '')
};
return result", methodParameters())
显示效果:
/**
* @param (参数1)
* @param (参数2)
* (......)
* @return 返回值
* @data 时间
* @description 描述
*/
现象一:IDEA提示悬空的注解
注释检查,可以通过以下方式禁用它:
点击idea左上角文件->点击设置
导航到编辑器 --> 检查
在右侧菜单列表下,选择 Java --> JavaDoc---也可直接搜索 JavaDoc
取消选中“悬空 Javadoc 注释”
现象二:IDEA提示标签说明已丢失
注释检查,可以通过以下方式禁用它:
点击idea左上角文件->点击设置
导航到编辑器 --> 检查
在右侧菜单列表下,选择 Java --> JavaDoc---也可直接搜索 JavaDoc
取消选中“声明有 Javadoc 的问题”
使用范围设置
记得选择注释使用范围---一般直接选择全部或者选择Java即可 , 方便又省事。也可以根据需求自行选择使用范围
最后点击 应用
、确认
就可以了。
注释使用
来到需要注释的 方法上 输入 /**
点击回车即可调出刚刚设置的注释
以上是根据我自己的喜好来设置的看着也还行、对于那些怕麻烦的朋友们就直接按着步骤来即可无需过多的设置
如果想要其他注释效果的在这基础上稍加修改即可。表达式也比较简单 , 看一下修改的地方也就是if判断和返回值了
以上方法本人亲测有效、没达到效果的伙伴们可以评论区留言解答
IDEA生成带参数和返回值注释的更多相关文章
- c#带参数和返回值的函数 开启线程调用的方法
public delegate string DgTest(); private void btn_District_Click(object sender, EventArgs e) { //实例化 ...
- 在IDEA中设置方法自动注释(带参数和返回值)
第一部分 设置 打开设置面板 新建 在线模板 新建自动添加规则,注意 这里触发的字符 不能随便写 必须为 * Template text 区域 看上去有点乱,但是是为了显示时的对齐,该区域的内容如下( ...
- C#多线程函数如何传参数和返回值
详见网站:http://WWW.MOVIH.COM就是一个多线程爬虫系统. C#多线程函数如何传参数和返回值 提起多线程,不得不提起 委托(delegates)这个概念. 我理解的委托 ...
- javascript函数参数、返回值类型检查
实现带参数.返回值类型声明的js函数: 类型定义:window.Str = Type.Str = Type.define('STRING', Type.isStr);var Per = Type.de ...
- C#调用存储过程带输出参数或返回值
CREATE PROCEDURE [dbo].[GetNameById] @studentid varchar(8), @studentname nvarchar(50) OUTPUT AS BEGI ...
- [转] ADO.NET调用存储过程带输出参数或返回值
CREATE PROCEDURE [dbo].[GetNameById] @studentid varchar(), @studentname nvarchar() OUTPUT AS BEGIN S ...
- swagger 接口文档,控制器 和 object类型的参数与返回值 的 注释不显示问题
一.控制器的注释不显示:是因为配置swagger的时候没有将includeControllerXmlComments参数配置为true,因为其默认值为false 二.object 类型的参数和返回值 ...
- Python 函数参数有冒号 声明后有-> 箭头 返回值注释 参数类型注释
在python3.7 环境下 函数声明时能在参数后加冒号,如图: 1 def f(ham: str, eggs: str = 'eggs') -> str : 2 print("Ann ...
- 微信公众号开发C#系列-11、生成带参数二维码应用场景
1.概述 我们在微信公众号开发C#系列-7.消息管理-接收事件推送章节有对扫描带参数二维码事件的处理做了讲解.本篇主要讲解通过微信公众号开发平台提供的接口生成带参数的二维码及应用场景. 微信公众号平台 ...
随机推荐
- 在oracle中创建管理员密码
1.因为在安装Oracle11g时没有设置sys和system用户的密码,导致登陆不上SQLplus,后面用sqlplus / as sysdba ,密码为:root登陆上去创建了密码. 2.如下图
- vue中vuex实现持久化的几种方法
前提:大家都知道vuex真的数据共享是不持久的,例如登录后一刷新,state中存的token就会消失,导致你需要再次进行登录操作 在这给大家列出几种解决方案: 第一种(也是一些项目中常使用的):使用缓 ...
- Java 数字转汉字
阿拉伯数字转汉字 public static String number2chinese(int src) { final String num[] = {"零", "一 ...
- Python爬虫之xpath语法及案例使用
Python爬虫之xpath语法及案例使用 ---- 钢铁侠的知识库 2022.08.15 我们在写Python爬虫时,经常需要对网页提取信息,如果用传统正则表达去写会增加很多工作量,此时需要一种对数 ...
- Java SE 9 模块化示例
Java SE 9 模块化示例 作者:Grey 原文地址:Java SE 9 模块化示例 说明 Java SE 9引入了模块系统,模块就是代码和数据的封装体.模块的代码被组织成多个包,每个包中包含Ja ...
- 刷题记录:Codeforces Round #725 (Div. 3)
Codeforces Round #725 (Div. 3) 20210704.网址:https://codeforces.com/contest/1538. 感觉这个比上一个要难. A 有一个n个数 ...
- java数组---稀疏数组与数组之间的相互转化
public static void main(String[] args) { int[][]array1=new int[11][11]; array1[1][2]=1; array1[2][3] ...
- java基础———注释
注释是写给读者看的,并不会被执行! 单行注释 以 //开头 例如://注释内容 可以注释一行文本 多行注释 以/*开头 以 */结束 例如:/*注释内容*/ ...
- 在 C# CLR 中学习 C++ 之了解 extern
一:背景 在 CLR 源码中有很多的 extern 和 extern "C" 这样的关键词,比如下面这些代码: extern size_t gc_global_mechanisms ...
- Java SE 多态
1.多态 方法的多态 //方法重载体现多态 A a = new A(); //这里我们传入不同的参数,就会调用不同sum方法 System.out.println(a.sum(10,20)); Sys ...