您的位置：首页 > 编程语言

VS code自定义用户代码片段snippet

2018-07-19 11:59 701 查看
版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/WHU_Kevin_Lin/article/details/81112987

我的模板：

  1. 【VS Code模板（snippet）】Vue CDN 开发模式 通用模板

文章目录

参考资料: https://code.visualstudio.com/docs/editor/userdefinedsnippets

1. 为什么要自定义代码片段？

 在使用Dreamweaver、Webstorm等HTML页面编辑器时，其自带的自动补全功能（我更乐意称之为模板）往往可以减少我们写代码时的工作量，但IDE打开速度慢、占用内存高的缺点不断蚕食我的耐心。当发现VS code的代码片段自定义功能后，我决定将web开发的主战场转移至其上，其轻量级和可扩展性是前所未有的吸引人的。

2. 怎么做？

 由于是在书写html页面时用到了代码片段功能，因此以创建html文件的代码片段为例说明创建的流程、语法。

2.1 流程

 打开VS code，“文件-首选项-用户代码片段”（file-preference-User Snippets），在下拉列表中选择html文件，此时在VS code的应用数据文件夹内自动新建了一个名为html.json的文件，我们在这个json文件中定义我们的代码片段。

 我们需要首先定义snippet name，在snippet name中，

prefix
和
body
是必不可少的两个字段(The prefix is what is used to trigger the snippet and the body will be expanded and inserted.)

 我们定义一个html框架，命名为html template，代码如下：

"html template": {
"prefix": "html template",
"body": [
"<!DOCTYPE html>",
"<html lang=\"en\">",
"<head>",
"\t<meta charset=\"UTF-8\">",
"\t<title>${1:Title}</title>${2}",
"</head>",
"<body>",
"\t${3}",
"</body>",
"</html>",
"${0}"
],
"description": "create a html frame"
}

 保存，新建一个html文件，输入

html template
，按下Tab键，就可以自动补齐整个框架。

2.2 语法说明

  • 在body中，使用转义字符
    \
    来书写制表符
    Tab
    、双引号
    "
    等内容；
  • 使用
    ${num: default name}
    来定义输入位置，按下Tab键来递进光标到下一个；
  • num
    的值为
    0,1,2,3...
    。
    0
    为光标的最终位置，
    1,2,3...
    决定了光标的顺序位置；
  • default name
    是默认值，可按下Tab不编辑直接跳过。

2.3 Global or Specific Snippets

 代码片段分为两种：全局和特定，这意味着我们可以定义适用于多种文件类型的代码片段，也可以定义仅仅针对于一种文件类型的代码片段。

 全局代码片段的文件后缀名为

.code-snippets
，在用户代码片段下拉列表中，最上方有一个“新建全局代码片段文件”。

 全局代码片段的语法规则和特定代码片段的语法规则一致，唯一区别在于其增加了一个字段

scope
，用于指定该规则适用于何种语言：（例）

{
"For_Loop": {
"prefix": "for",
"scope": "javascript,typescript",
"body": [
"for (const ${2:element} of ${1:array}) {",
"\t$0",
"}"
],
"description": "For Loop"
},
}

2.4 自定义引用css和JavaScript的标签的代码片段

"link template": {
"prefix": "<link rel...",
"body": [
"<link rel=\"stylesheet\" type=\"${1:text/css}\" href=\"${2}\">${0}"
],
"description": "complete css link"
},
"script template": {
"prefix": "<script type...",
"body": [
"<script type=\"${1:text/javascript}\" src=\"${2}\"></script>${0}"
],
"description": "complete script quote"
}
阅读更多
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 点击这里给我发消息
标签： 
相关文章推荐
新的分享
章节导航