如何在 VS Code 中创建和管理代码片段

作者:Sayaib Sarkar更新于 阅读约 4 分钟

本页内容 5 个小节

简短回答:VS Code 内置了代码片段功能:运行 Snippets: Configure Snippets,选择一种语言或一个项目文件,然后用 JSON 编写每个片段,包含 prefix 和 body。如果想更快,可以使用 DevSnip Pro 的 Create Snippet,几秒钟就能把选中的代码保存为片段,还可以使用它为 Spring Boot、ASP.NET Core、FastAPI、React、Next.js、Flutter 和 SwiftUI 提供的 ds- 片段。

好的代码片段节省的不只是按键次数。它记录的是你已经调试过的模式版本:带有正确状态码的错误处理、配置正确的测试、会检查 response.ok 的 fetch 封装。

VS Code 把代码片段放在哪里

范围文件用途
单一语言用户代码片段文件夹中的 typescript.json某一种语言的个人片段
全局用户代码片段文件夹中的 *.code-snippets适用于多种语言的个人片段
项目仓库中的 .vscode/*.code-snippets与代码一起提交的团队片段

在命令面板(Ctrl/Cmd+Shift+P)中运行 Snippets: Configure Snippets(旧版本中为 Preferences: Configure User Snippets),即可打开其中任意一个。

手动编写代码片段

代码片段是一个具名条目,包含你要输入的文本(prefix)、要插入的代码行(body),以及可选的、显示在 IntelliSense 中的 description:

JSON
{
  "Express route handler": {
    "prefix": "exroute",
    "scope": "javascript,typescript",
    "body": [
      "router.${1|get,post,put,delete|}('/${2:path}', async (req, res, next) => {",
      "  try {",
      "    $0",
      "  } catch (err) {",
      "    next(err);",
      "  }",
      "});"
    ],
    "description": "Async Express route that passes errors to next()"
  }
}

让代码片段真正好用的语法:

  • $1、$2…… 是 Tab 停靠点:按 Tab 在它们之间移动,$0 是光标最后停留的位置。
  • ${1:path} 是带默认文本的占位符,可以直接覆盖输入。
  • ${1|get,post,put,delete|} 是选项:一个可选值的下拉列表。
  • $TM_FILENAME_BASE、$CURRENT_YEAR、$CLIPBOARD 等变量会插入上下文信息。${TM_FILENAME_BASE/(.*)/${1:/pascalcase}/} 会把 user-card 变成 UserCard。
  • scope(在 .code-snippets 文件中)用于把片段限制在某些语言中。

在 body 中,字面量 $ 要转义为 \\$,占位符中的 } 要转义为 \\}。

从选中的代码保存片段

手写带有转义引号的 JSON 是最慢的部分。使用 DevSnip Pro:

  1. 选中要复用的代码。
  2. 运行 DevSnip Pro: Create Snippet。
  3. 输入要键入的前缀、名称和可选的描述。
  4. 出现提示时重新加载窗口。VS Code 会在启动时加载扩展提供的代码片段。

之后,该片段就会出现在这种语言的 IntelliSense 中(支持 39 种语言)。如果这个前缀已被你的其他片段占用,会先询问你,避免出现两个片段同时弹出的情况。DevSnip Pro: Saved Snippets 会列出你保存过的所有片段,并可删除不再使用的。

使用现成的框架代码片段

在支持的文件中输入 ds-,或运行 DevSnip Pro: Framework Snippets 从列表中选择。一共有 56 个,每个都经过 VS Code 展开并编译(在框架允许时还会运行),所以插入后即可使用:

  • Spring Boot:ds-rest-controller、ds-service、ds-entity、ds-repository、ds-controller-advice、ds-webmvctest、ds-junit
  • ASP.NET Core:ds-minimal-api、ds-api-controller、ds-exception-handler、ds-dbcontext、ds-xunit、ds-webapp-test
  • Python:ds-fastapi-app、ds-fastapi-router、ds-pydantic、ds-flask-route、ds-django-view、ds-pytest、ds-pytest-fixture
  • React 与 Next.js:ds-rfc、ds-hook、ds-context、ds-next-page、ds-next-route、ds-server-action、ds-rtl
  • TypeScript 与 Node.js:ds-express-router、ds-express-error、ds-zod、ds-fetch-json、ds-vitest
  • Flutter 与 SwiftUI:ds-stless、ds-stful、ds-future-builder、ds-swiftui-view、ds-view-model

Java、C#、Python 和 Swift 还有一个 ds-logger 片段。它会创建日志记录器,之后 Insert Debug Log 会用它来写调试日志。

让代码片段集合保持好用

  • 按片段生成的内容来命名前缀,而不是按来源命名:exroute 比 snippet3 好。共同的开头(例如 ds-)能把它们在 IntelliSense 中归为一组。
  • 让片段保持小巧。生成整个文件的片段很难调整;需要完整资源时,生成器更合适。DevSnip Pro 的 API Resource Scaffolder 可为 Express、NestJS、Next.js、Fastify、Spring Boot、ASP.NET Core 或 FastAPI 生成带分页、经过校验的 CRUD API。
  • 通过仓库共享团队片段。.vscode/project.code-snippets 文件会像代码一样被版本管理和评审,每个打开项目的人都能用上。
  • 定期清理。几个月都没用过的片段就删掉,这样常用的片段更容易找到。

在你自己的编辑器中试试

免费、无需账号、本地运行。支持 Windows、macOS 和 Linux 上的 VS Code 1.93+ 与 JetBrains IDE。

code --install-extension sayaib.hue-console