代码片段指南

The contributes.snippets 贡献点允许您将代码片段捆绑到 Visual Studio Code 扩展中以供共享。

The 创建代码片段 主题包含创建代码片段的所有信息。本指南/示例仅展示如何将您自己的代码片段转换为可供共享的扩展。建议的工作流程是

• 使用 代码片段：配置用户代码片段 命令创建和测试您的代码片段。
• 如果您对代码片段感到满意，请将整个 JSON 文件复制到扩展文件夹中，例如 snippets.json。
• 将以下代码片段贡献添加到您的 package.json 中。

{
  "contributes": {
    "snippets": [
      {
        "language": "javascript",
        "path": "./snippets.json"
      }
    ]
  }
}

提示：在您的 package.json 中使用以下配置将您的扩展标记为代码片段扩展。

{
  "categories": ["Snippets"]
}

您可以在以下位置找到完整的源代码：https://github.com/microsoft/vscode-extension-samples/tree/main/snippet-sample.

使用 TextMate 代码片段

您还可以使用 yo code 扩展生成器将 TextMate 代码片段 (.tmSnippets) 添加到您的 VS Code 安装中。生成器有一个 新的代码片段 选项，可以让您指向包含多个 .tmSnippets 文件的文件夹，并将它们打包到 VS Code 代码片段扩展中。该生成器还支持 Sublime 代码片段 (.sublime-snippets)。

最终的生成器输出有两个文件：扩展清单 package.json，它包含将代码片段集成到 VS Code 中的元数据，以及 snippets.json 文件，它包含转换为 VS Code 代码片段格式的代码片段。

.
├── snippets                    // VS Code integration
│   └── snippets.json           // The JSON file w/ the snippets
└── package.json                // extension's manifest

将生成的代码片段文件夹复制到 .vscode/extensions 文件夹下的新文件夹中，然后重新启动 VS Code。