IDEA自定义注释模板实现方法。

亦凉 2023-10-11 18:17 10阅读 0赞

IDEA作为我们常用的一款开发工具，为我们的开发作出了巨大的贡献，但是随着代码量的加大，注释也就变得尤为重要，那么我今天就给大家分享一下我实现自定义注释模板的实现方法。

一、打开IDEA，点击File | Settings | Editor | File and Code Templates，输入下面代码。

/**
    
    * @ClassName ${NAME} * @Description TODO
    
    * @Author ${USER}
    
    * @Date ${TIME} ${DATE}
    
    * @Version 1.0
    
    **/

二、打开File | Settings | Editor | Live Templates，点击“+”，添加livetemplate，如下。

![9182504c995d4b9da96c80045b2ace74.png][]

三、设置快捷键和注解。

![df32f5a4df3947979fcbadceb16e7578.png][]

四、 写入如下代码。

*
    * @param $params$
    * @author $user$
    * @date $date$ $time$
    * @return $return$
    **/

五、设置change，选择Java。

![acc707dd996f49a891b373c703739ad1.png][]

六、点击edit variables设置参数。

![84d3666741964aa485924895bed399a7.png][]

1、 params

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

2、return

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

3、expression可选择。

![930174b51039438bb858c4c8d2373bb5.png][]

七、点击Apply——OK，即可。

![bb81ca1ad97f4f91819bdffc5c73fd5c.png][]

八、测试，输入快捷键/\*\*+Enter

![3c93e4cab6e04404a7ccf99e7f89d826.png][]

如此，我们便可实现自定义模板注释了，快行动起来吧。

[9182504c995d4b9da96c80045b2ace74.png]: https://img-blog.csdnimg.cn/9182504c995d4b9da96c80045b2ace74.png
[df32f5a4df3947979fcbadceb16e7578.png]: https://img-blog.csdnimg.cn/df32f5a4df3947979fcbadceb16e7578.png
[acc707dd996f49a891b373c703739ad1.png]: https://img-blog.csdnimg.cn/acc707dd996f49a891b373c703739ad1.png
[84d3666741964aa485924895bed399a7.png]: https://img-blog.csdnimg.cn/84d3666741964aa485924895bed399a7.png
[930174b51039438bb858c4c8d2373bb5.png]: https://img-blog.csdnimg.cn/930174b51039438bb858c4c8d2373bb5.png
[bb81ca1ad97f4f91819bdffc5c73fd5c.png]: https://img-blog.csdnimg.cn/bb81ca1ad97f4f91819bdffc5c73fd5c.png
[3c93e4cab6e04404a7ccf99e7f89d826.png]: https://img-blog.csdnimg.cn/3c93e4cab6e04404a7ccf99e7f89d826.png