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.消息管理-接收事件推送章节有对扫描带参数二维码事件的处理做了讲解.本篇主要讲解通过微信公众号开发平台提供的接口生成带参数的二维码及应用场景. 微信公众号平台 ...
随机推荐
- PostGresql listen与notify命令
LISTEN与NOTIFY命令 PostgreSQL提供了client端和其他client端通过服务器端进行消息通信的机制.这种机制 是通过LISTEN和NOTIFY命令来完成的. 1.LISTEN与 ...
- BootStrap详解
1. bootstrap的安装和使用 官网: https://getbootstrap.com/ 中文网: https://www.bootcss.com/ 菜鸟驿站教程网: https://www. ...
- CF383C Propagating tree (线段树,欧拉序)
\(tag\)没开够\(WA\)了一发... 求出\(dfs\)序,然后按深度分类更新与查询. #include <iostream> #include <cstdio> #i ...
- 记Windows服务器Redis 6379被攻击 被设置主从模式同步项目数据
在工作中第一次经历被攻击,我是一个前端,同时复负责维护一个已上线的项目,在最近一段时间小程序与后台经常出现这个报错, 搜了下说我的从机是只读模式,不能写入,问了同事得知这个项目是单机模式,根本不存在从 ...
- 跟我学Python图像处理丨基于灰度三维图的图像顶帽运算和黑帽运算
摘要:本篇文章结合灰度三维图像讲解图像顶帽运算和图像黑猫运算,通过Python调用OpenCV函数实现. 本文分享自华为云社区<[Python图像处理] 十三.基于灰度三维图的图像顶帽运算和黑帽 ...
- 如何使能512个virtio_blk设备
一例virtio_blk设备中断占用分析 背景:这个是在客户的centos8.4的环境上复现的,dpu是目前很多 云服务器上的网卡标配了,在云豹的dpu产品测试中,dpu实现的virtio_blk 设 ...
- 字节跳动端智能工程链路 Pitaya 的架构设计
Client AI 是字节跳动产研架构下属的端智能团队,负责端智能 AI 框架和平台的建设,也负责模型和算法的研发,为字节跳动开拓端上智能新场景.本文介绍的 Pitaya 是由字节跳动的 Client ...
- vim 正则表达式
1.查找字符串 /str n 下一个 2.替换表达式 :[range]s/from/to/[flags] range:搜索范围,如果没有指定范围,则作用于但前行. :1,10s/from/to/ 表示 ...
- 【读书笔记】C#高级编程 第五章 泛型
(一)泛型概述 泛型不仅是C#编程语言的一部分,而且与程序集中的IL代码紧密地集成.泛型不仅是C#语言的一种结构,而且是CLR定义的.有了泛型就可以创建独立于被包含类型的类和方法了. 1.性能 泛型的 ...
- ELK接收paloalto防火墙威胁日志并定位城市展示
ELK接收paloalto防火墙威胁日志并定位城市展示 一.准备环境: 搭建好的ELK环境 palo alto防火墙(企业用的) 二.安装logstash并做好过滤 将palo alto日志打到一台c ...