IDEA 设置: Live Templates 方法注释 注释模板编写

IDEA: Live Templates 方法注释 注释模板编写：

打开IDEA开发工具进入设置找到Editor: File>>Setting>>Editor>>Live Templates

进入Live Templates 设置页面：

　　首先创建属于自己的模板组 >> 创建模板 按上图步骤依次完成

开始对模板进行配置显示的内容：

　　设置模板的Abbreviation 缩写 — 必填 >> 注释 Description — 可选 >> 模板内容 Template text –必填 >> 选择模板的作用范围 >> 快捷键设置。 按上图步骤依次完成(也可步骤来)

　　强调：模板名称必须为 * ，也就是Abbreviation 缩写必须是 * 。

匹配模板内容中定义的变量进行赋值操作：

$***$是在模板内容中定义一个变量；

$END$ 是个比较特殊的变量指定了模板内容加载完成后光标显示的位置；如果想要指定结束光标的位置则需要把每个变量的 Skip if defined 勾选上，如下图

以上为设置 Live Templates 的步骤，这篇文章说的是创建自己的‘方法注释模板’，图示所显内容也都是方法注释方面的，下面贴出各图中用到的代码，附解释：

Template text 模板内容:

/**
 * @Author drj
 * @Date $date$
 * @description $END$
 $param$
 * @Return $return$
 */

变量值赋值：

这个比较特殊需要手写代码实现获取参数   $param$ 变量值：
groovyScript(" 
def result = ''; 
def param = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); 
for(int i = 0;i < param.size();i++) 
{    
    result += '* @Param ' + param[i] + ((i < param.size() - 1) ? '\\n' : ''); 
};
return result;
",methodParameters()) 

$date$、$return$ 的值可在Expression 栏中进行选择对应赋值内容

复制粘贴到对应栏后直接 点击 OK 即可

开始测试 注释模板： 看下图

在测试过程中发现，只有在方法内部时才会拿到 Param和Return 的值，而在方法外是拿不到的。

我们就是为了图方便才写的注释模板，这样我们每次在使用这个注释模板的时候岂不是都要先在方法内 {* + tab}键后才能拿到完整的注释内容吗？ 然后再复制到方法外，这不是又徒增了一步吗？

为了将方便(懒)贯彻到底，又寻找尝试了另一种写法 发现是可以在 方法外直接 {* + tab}键 出现方法的完整注释的。在使用之前我们先对模板内容进行一个小更改，就是把第一行的 / 去除即可，

然后为了保证注释内容加载出来是完整的注释，这时候的快捷按键就得调整为：{/* + tab}键。

看效果如图：

注释模板完成了！

为什么这样才能在外部拿到值，我暂时也还不太清楚，等了解之后再写到文章内！

有什么不解大家可以留言评论下，大家共同交流

参考链接：https://blog.csdn.net/qinqigang/article/details/79071486

转载于:https://www.cnblogs.com/dreamhero/p/11225315.html

原文链接：https://blog.csdn.net/weixin_30342827/article/details/101396040

本站声明:网站内容来源于网络,如有侵权,请联系我们,我们将及时处理。