VSCode插件开发指南之Snippets Syntax(1)

指南1.基础

Code Sinpets是一种使得输入重复性代码的模板，比如循环和条件判断之类的。VSCode中的Sinppets遵循TextMate语法，除了不支持插值shell代码和\u的使用。

下面是一个简单的sinppets。

{
   
    "For-Loop":{
   
        "prefix":"for",
        "body":[
            "for ${2:element} of ${1:array} {",
            "\t$0",
            "}"
        ],
        "description":"For-Loop"
    }
}

上面的字段解释:

• For-Loop:这是snippets的名称
• prefix:定义了这个snippets如何被触发,在这个case中是for
• body:内容是一个可以被插入的单字符串或者一个字符串数组
• description:是snippets的描述

上面的例子中有两个空格：${1:array}和${2:element}。我们可以按照数字的顺序很快地让过他们。数字之后的字符串和:(colon)可以被用作初始值。

下面就让我们学习一下Snippest Syntax的语法。

Snippets Syntax

sinppets的body部分可以使用特别的结构体来控制光标和插入的文件。下面的是支持的特性和他们的语法：

Tabstops

通过tabstops,你可以使编辑光标移动进一个sinppets。使用$1,$2来指定光标位置。数字是tabstops访问的顺序。而(whereas)$0表示的是光标最终的定位。发生在多行的相同tabstop会被同步关联和更新。

占位符(Placeholders)

占位符是带有值的tabstops,就像${1:foo}。占位符文本可以被插入和选中，这样的话可以很容易被修改。占位符可以嵌套使用，就像${1:another ${2:placeholder}}。

选择(Choice)

占位符可以是有选择的值 ， 语法是独立的枚举值 ，用|符号进行关闭 ，比如${1|one,two,three|}。当snippets被插入并且站位符被选中的时候，选择会弹出一共用户选择 。

变量

通过$name或者<