教程:在 TODO 评论中使用实时模板
让我们探索一个高级的 PhpStorm 工具来为 TODO 项的文本创建一个实时模板。为什么我们需要它?例如,您希望您的队友创建统一的 TODO 项,自动填写用户名,后跟一些任意文本。
这就是它的完成方式。
创建 TODO 模式和过滤器
打开 Settings/Preferences 对话框,然后在 Editor 部分下,单击TODO。
创建图案 review
。为此,请单击“模式”部分:
在颜色选择器中定义颜色 - 在这种情况下,它是粉红色。
接下来,让我们创建一个过滤器。为此,请单击过滤器部分,然后定义过滤器:
创建实时模板和变量
接下来,返回Settings/Preferences对话框 ( Ctrl+Alt+S),在 Editor 部分下,单击Live Templates。
请注意,新模板将添加到自动创建的组user
中。
接下来,注意底部的红色注释。它说新模板缺少应该应用的上下文。所以让我们点击链接定义,并允许所有可能的上下文。最后,让我们定义模板本身的主体:在模板文本区域中,输入以下内容:
REVIEW[$WHO$] $TEXT$
我们这里有两个未定义的变量:$WHO$
和$TEXT$
. 该变量$TEXT$
将仅用作输入字段,而该变量$WHO$
应自动填写。要定义此变量,请单击按钮Edit variables:
接下来,在“编辑模板变量”对话框中,为变量选择一个表达式$WHO$
:
使用 REVIEW 项目
现在让我们确保它有效。回到编辑器,创建一行注释Ctrl+/,输入rv
,然后按Tab:
请注意,TODO 注释旁边的右装订线也被添加到编辑器中。如您所见,实时模板rv
已自动填充用户名,让我们只需输入一些有意义的评论即可:
现在,当您选择仅显示REVIEW评论时,请使用过滤器。为此,请单击并选择过滤器评论以仅显示具有关键字REVIEW的 TODO 评论。
最后修改时间:2021 年 3 月 8 日