IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> 开发工具 -> idea配置自动生成注释相关问题解决 -> 正文阅读

[开发工具]idea配置自动生成注释相关问题解决

作者:https://csdnimg.cn/release/blogv2/dist/mdeditor/css/editerView/markdown_views-d7a94ec6ab.css

其实网上很多设置类注释的地方,所以具体步骤就不写了。主要写今天碰到的几个问题吧。

标题

1、关于设置methodParameters() 不生效问题:

所有现在博文有两种,一种是使用methodParameters(),一种是使用一行脚本,脚本问题2贴。
不知道是不是我idea版本问题,我直接快捷键+tab出来,@param出来总是空的,各种测试以后,发现先输入/,然后快捷键+tab出来就对了。或者先输入/+快捷键,然后tab,注释就出来了.简单来说就是/+快捷键+tab。也就是必须配合/使用,出来的注释的methodParameters才不是空。但是这样导致结果就是自动生成的配置多了/,所以配置的注释里面,不需要/,也就是直接**开头

2、多个param,数组显示,而不是每个一行显示,解决方式如下:

params不要直接使用methodParameters(),使用如下配置:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n     ' : '')}; return result", methodParameters())

3、生成的注解缩进有问题:

如果缩进有问题,调整上面 \n后面的空格数量。或者* @param:前面的空格,其实就是脚本里面空格数不太对,稍微调整一下空格数即可。

4、生成的注解,加上注释以后,格式会变一下:

在配置界面勾上reformat according to style
在这里插入图片描述

4、生成注解里面参数有报错:@param *** tag description is missing

其实是@param后面缺少了:,不需要甚至javadoc的告警级别。加上:就行了。如下图filepath就没错,interfaceFile就有那个告警。加上:就好了
在这里插入图片描述

综上,下面是我的配置,我这么配置的原因就是解决上面的问题。

** 
 * @Description: $description$
 * @author: lvly
 * @date: $date$ $time$
 $params$
 * @return: $returns$
 * @throws: 
*/

params配置:

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n     ' : '')}; return result", methodParameters())

我设置的快捷键是q,所以我输入/q 然后点击tab,出现注释如下:

    /**
     * @Description: 
     * @author: lvly
     * @date: 2021-07-27 14:39
     * @param: filePath
     * @param: interfaceFile
     * @return: java.lang.String
     * @throws:
    */
  开发工具 最新文章
Postman接口测试之Mock快速入门
ASCII码空格替换查表_最全ASCII码对照表0-2
如何使用 ssh 建立 socks 代理
Typora配合PicGo阿里云图床配置
SoapUI、Jmeter、Postman三种接口测试工具的
github用相对路径显示图片_GitHub 中 readm
Windows编译g2o及其g2o viewer
解决jupyter notebook无法连接/ jupyter连接
Git恢复到之前版本
VScode常用快捷键
上一篇文章      下一篇文章      查看所有文章
加:2021-07-28 08:01:43  更:2021-07-28 08:03:33 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 -2024/11/20 13:35:20-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码