VS Code中代码片段的定义和使用

今天学习到了VS Code中代码片段的创建和使用,记录如下。

这里以PHP代码片段为例。

创建代码片段

依次点击File -> Preferences -> User Snippets,输入php并回车,即可打开PHP语言的代码片段文件。在片段文件中新建代码片段,并保存。

片段的定义规则很简单:

  • 前缀prefix表示片段的简写;
  • 代码片段的具体定于位于body中,每一项代码最终输出的一行代码;
  • 占位符${1:funcname}表示这是第1个占位符,funcname是其默认值;
  • 各占位符可通过Tab键切换,其顺序就是占位符定义中的数字;
  • $0是最后一个占位符;
  • 可以使用转义字符,如\t就表示输出一个Tab。

使用代码片段

在PHP代码文件中输入片段的前缀,此处为met,按Tab键,即可出现代码片段。

三种代码片段

VS Code支持三种代码片段,分别是全局级、语言级和项目级。其中项目级代码片段是从VS Code 1.28开始支持的,刚好是本文初版完成后数小时。

上图中,New Global Snippets file表示全局级代码片段,New Snippets file for ‘bs’表示为项目bs(文件夹)建立代码片段,php.json (php)表示语言级代码片段。

参考资料:

Creating your own snippets