程式碼片段指南

contributes.snippets 貢獻點讓您可以將程式碼片段捆綁到 Visual Studio Code 擴充功能中以進行分享。

建立程式碼片段 主題包含建立程式碼片段的所有資訊。本指南/範例僅說明如何將您自己的程式碼片段轉換為擴充功能以進行分享。建議的工作流程是

• 使用 程式碼片段：設定使用者程式碼片段 命令建立並測試您的程式碼片段
• 一旦您對程式碼片段感到滿意，請將整個 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。