请选择 进入手机版 | 继续访问电脑版

IntelliJ IDEA 为方法设计Javadoc注释模板(可解决阿里巴巴代码规范检测中

[复制链接]
听见深浅 发表于 2021-1-1 17:48:29 | 显示全部楼层 |阅读模式 打印 上一主题 下一主题

注:本文中的例子以IntelliJ IDEA为例
问题泉源

如果下载了阿里巴巴代码规范检测这个插件,各人一定经常会为这个眼熟的提示感到头疼,然而强迫症又很想把它弄好,如果手敲会很贫苦,所以博主在网上查了一下如何设置javadoc注释模板,网上大多文章有内容但不齐备,所以写一篇博客并将个人比较喜欢的一种方式分享出来。
办理方案


  • 点击 File → Settings... → Editor → Live Templates


    2.点击右侧的+,首先选择Template Group,任意取一个名字,这里我们设计的是注释模板,所以我取名为注释

3.点击刚刚创建好的模板组,再点击+,选择Live Template,会出现下图的界面
接下来的操纵如图所示

5.点击模板页面最下方的告诫define,来设置将模板应用于哪些场景(如果曾经修改过,则显示为change而不是define)

6.第三步的注释文本如下
  1. ** * Desc:$param$ * @return $return$ * @author baskbull * @date $date$ $time$ */
复制代码
7.第五步设置变量,点击Edit variables,会读取刚刚在注释模板中的设置的参数 $参数名$ 。在Expression的中为其赋值。(记得勾选后面的勾)

date和time比较简朴,在下拉框中或者直接敲都可以,关键是return和param,虽然expression中为我们提供了方法


  • methodParameters()
  • methodReturnType()
    但它是这样显示的:

我并不适应这种形式,所以举行了一定优化
(1)在param中复制下文脚本:
  1. groovyScript("def result=&#39;&#39;; def params="${_1}".replaceAll(&#39;[\\\\[|\\\\]|\\\\s]&#39;, &#39;&#39;).split(&#39;,&#39;).toList(); for(i = 0; i < params.size(); i++) {result+=&#39; * @param &#39; + params[i] + ((i < params.size() - 1) ? &#39;\\r\\n&#39; : &#39;&#39;)}; return result", methodParameters())
复制代码
(2)在return中复制下文脚本:
  1. groovyScript("def result="${_1}"; if(result == "void"){return "";}else{return "{@link "+result+"}";}", methodReturnType())
复制代码

在@author后各人可以到场自己的名字,这样处置惩罚后,产生的效果相对来说悦目一些
8.在第六步中,可以在expand with设置模板产生的方法:博主更适应enter,所以选择了enter方法,而且勾选下面的勾

9.调用注释模板:因为刚刚我们把*设置为模板的快捷键,enter键设置为模板的扩展快捷键,所以通过输入/* + enter键,即先输 /* 再按enter键,即可调用模板。
大功告成!在网上查了很多人的博客,此中博客园中PC君的博客对我资助最大,感谢!

来源:https://blog.csdn.net/Firelearn/article/details/111992059
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则


专注素材教程免费分享
全国免费热线电话

18768367769

周一至周日9:00-23:00

反馈建议

27428564@qq.com 在线QQ咨询

扫描二维码关注我们

Powered by Discuz! X3.4© 2001-2013 Comsenz Inc.( 蜀ICP备2021001884号-1 )