IDEA通过脚本生成注释@param后输入注释内容自动缩进问题解决

我不是女神ヾ 2023-06-22 03:19 6阅读 0赞

### 文章目录 ###

*   *  一、文章说明
     *  二、问题介绍
     *  三、问题解决

## 一、文章说明 ##

1.  用IDEA的朋友应该知道生成注释的模板@param是把多个参数通过了,分隔放在了一行上
2.  那么对于需要给每一个参数作说明的话是很不方便的，需要自己手动复制删除，比较繁琐
3.  所以网友也提供了一个groovyScript替换了原来@param生成，但是这个脚本有一个问题就是生成注释后输入字符除了第一个@param外下面的@param会缩进，我看网上也很少有解决方法，所以接下来说一下解决方案

## 二、问题介绍 ##

1.  原始网友提供的脚本如下

> 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())

1.  配置完成后生成注释在没有输入注释内容之前如下图所示  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9jb2RlY29vcmQuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70]
2.  此时发现@param是对齐的，但是当输入注释内容@param就会自动缩进  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9jb2RlY29vcmQuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 1]
3.  如果不解决就需要手工格式化，拒绝繁琐的工作，所以我们需要脚本进行改进

## 三、问题解决 ##

1.  从脚本可以发现，每一行换行都是追加的 \* @param，而问题是除了第一个@param外下面的@param会缩进  
    ![在这里插入图片描述][20191213160955309.png]
2.  所以我们解决方案就是除了第一个外，后面的@param在前面多加几个空格，根据自己的代码风格来设置，比如我的风格是4个空格，所以在原来的基础上多加四个空格，比如  
    ![在这里插入图片描述][201912131615052.png]
3.  修改后的脚本如下

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

1.  测试结果，输入内容回车也好还是tab也好，@param不再缩进  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9jb2RlY29vcmQuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 2]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9jb2RlY29vcmQuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191213160728744.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9jb2RlY29vcmQuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9jb2RlY29vcmQuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191213160822511.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9jb2RlY29vcmQuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70
[20191213160955309.png]: https://img-blog.csdnimg.cn/20191213160955309.png
[201912131615052.png]: https://img-blog.csdnimg.cn/201912131615052.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9jb2RlY29vcmQuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20191213161550594.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9jb2RlY29vcmQuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70