创建和编辑动态模板

在这个页面中:

介绍

PhpStorm自带一套预定义动态模板。你可以按原样使用它们,或者根据需要修改它们。如果你想创建一个新的动态模板,在拷贝现有模板的基础上,或者从代码中的片段。

如果一个模板已经被修改,它总是可以被重置为默认设置。

修改现有模板

要修改现有模板

  1. 在设置参数对话框,打开动态模板页面。
  2. 展开目标模板组,并选择要修改的模板。
  3. 模板文本区域,根据需要修改模板缩写
  4. Template Text字段,编辑模板主体,可能包含纯文本或这种格式$<variable name>$的变量.

    当编辑动态模板变量时,注意以下有用的提示:

    • 如果你在模板文本需要($)符号,可以通过重复这个字符($$)来显示。
    • 要改变模板中的变量,点击Edit Variables并按照创建和编辑模板变量章节的描述配置变量。

      Edit Variables按钮仅在模板主体中包含至少一个用户定义变量时可用,也就是说,和$END$$SELECTION$不同的变量。

      关于预定义模板变量的边注

      PhpStorm支持两种预定义动态模板变量:$END$$SELECTION$

      你不能编辑预定义动态模板变量$END$$SELECTION$

    • $END表明光标的位置在展开的模板之后。例如,模板return $END$;将展开到:

      1. return ;

      光标位置在分号之前。

    • $SELECTION$用在环绕模板中并且用来代表要被包围的代码片段。在模板展开之后,被选中的文本将在模板中被围绕。

      例如,如果你在代码中选择EXAMPLE并调用"$SELECTION$"模板(通过分配的缩写或按下Ctrl+Alt+T并从列表中选择目标的模板),PhpStorm将用两个引号包围选中的部分,就像下面:

      1. "EXAMPLE"
  5. Option部分,指定模板将如何展开并被重新格式化。

  6. Available in部分,指定在编辑器中可以感知模板缩写的语言和代码位置。
  7. 准备好后点击OK

从头创建新的动态模板

从头创建新的动态模板

  1. 在设置参数对话框,打开动态模板页面,并展开要创建的新模板所处的模板组。
  2. 点击新增。一个新的模板项目被添加到组中并将焦点移动到模板文本区域.
  3. 指定新模板的缩写,输入模板主体,定义变量和模板组,配置选项,按照模板修改规程的描述。
  4. 准备好后点击OK

从文本片段创建新的动态模板

要从文本片段创建新的动态模板

  1. 在编辑器中,选择要创建为动态模板的代码段。
  2. 在主菜单,选择Tools | Save as Live Template。然后动态模板页面打开了,焦点在模板文本区域。
  3. Abbreviation字段,输入识别你的新动态模板的缩写。
  4. 指定新模板的缩写,输入模板主体,定义变量和模板组,配置选项,按照模板修改规程的描述。
  5. 准备好后点击OK

搜索动态模板列表

要搜索动态模板列表

  • 动态模板页面,输入任意字符串,这些字符串是你想要的模板中缩写,主体或描述的一部分。

    PhpStorm显示所有匹配的模板:

    显示匹配的模板

重置为默认

要重置模板的设置为默认

注意,修改后的模板的显示颜色是蓝色的。

  1. 动态模板页面,右键单击一个修改后的模板来显示出上下文菜单
  2. 选择这个修改后模板的上下文菜单中的Restore defaults

另请参阅:

如何使用:

参考:

概念: