在线代码到代码片段转换工具,支持 JavaScript / TypeScript / React / JSX / TSX      

请输入代码片段名称 (name)
请输入代码片段前缀 (prefix)
请输入片段描述 (description)
请输入代码文本 (code body)
生成类型
生成的代码片段结果

VSCode 如何使用代码片段


Snippets in Visual Studio Code
VS Code 代码片段是一种强大的方法,它通过自动插入常用的代码块来提高您的编码效率。它们可以是简单的文本扩展,也可以是带有占位符和变量的更复杂的模板。以下是如何利用它们:

创建代码片段:

访问代码片段设置:转到文件 > 首选项 > 用户代码片段(macOS 上为代码 > 首选项 > 用户代码片段)。或者,使用命令面板(Ctrl+Shift+P 或 Cmd+Shift+P)并输入“首选项:配置用户代码片段”。

选择语言:系统将提示您为代码片段选择一种语言(例如,javascript.json、python.json 等)。这可确保代码片段仅适用于该特定语言。如果您希望代码片段可在所有语言中访问,您还可以创建“全局代码片段”文件。

定义代码片段:代码片段以 JSON 格式定义。每个代码片段都有一个名称、一个前缀(您输入的快捷方式以触发代码片段)、一个正文(要插入的代码)和一个可选的描述。

示例(JavaScript):
{
  "For Loop": {
    "prefix": "forl",
    "body": [
      "for (let i = 0; i < $1; i++) {",
      "  $0",
      "}"
    ],
    "description": "For loop with index"
  }
}
在此示例中:

“For Loop”:代码片段的名称(供您参考)。
“forl”:前缀。输入“forl”并按 Tab 键将插入代码片段。
“body”:要插入的代码。$1、$2 等是制表位(占位符)。$0 是最终光标位置。
“description”:IntelliSense 建议中显示的可选描述。
使用代码片段:

输入前缀:在正确语言类型的文件中,开始输入您定义的前缀(例如 forl)。

选择代码片段:VS Code 的 IntelliSense 将建议代码片段。使用箭头键或单击选择它。

使用制表位:按 Tab 在制表位($1、$2 等)之间导航并填写值。

变量:

代码片段还可以使用变量,例如 $TM_FILENAME、$CURRENT_YEAR 等。有关完整列表,请参阅 VS Code 文档。

带变量的示例(Python):
{
  "New Python File": {
    "prefix": "newpy",
    "body": [
      "#!/usr/bin/env python3",
      "# -*- coding: utf-8 -*-",
      "",
      "# ${TM_FILENAME}",
      "# Created by: ${USER} on ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}"
    ]
  }
}
通过掌握代码片段,您可以显著减少重复输入并确保代码的一致性。尝试为常用的代码模式创建自己的代码片段,并观察您的编码效率飙升。