使用 VSCode 设置代码片段(Snippets)

在 Visual Studio Code 中,代码片段 (Snippets) 是一种强大的功能,允许开发者通过简短的前缀快速插入 预定义的代码模板。通过配置代码片段,你可以更简洁地添加代码模板,从而提高开发效率和代码一致性。


什么是Snippets?

Snippets,代码片段。 是一组预定义的代码模板,可以通过输入特定的前缀并按下触发键(通常是 Tab 键)快速插入。这不仅节省了重复输入代码的时间,还确保了代码的一致性和规范性。

配置全局Snippets

  • 步骤一
    在VS Code界面中,使用快捷键Ctrl+Shift+P打开命令面板。在搜索框中输入snippets,选择Configure Snippets

  • 步骤二

    为你的即将创建的新Snippets模板文件拟一个名称,然后Enter创建。

  • 步骤三

    根据范例创建对象,及配置属性。
    scope:适用于此代码片段的文件类型;
    prefix:触发Snippets的前缀;
    body:代码内容。

配置Markdown模板

在VS Code中Ctrl+N新建文件时,键入简洁的前缀,自动生成Markdown文件模板

配置VS Code用户设置

  1. Ctrl+Shift+P搜索Open User Settings.json
  2. 在json文件中添加以下代码:
"[markdown]":  {  
    "editor.quickSuggestions": true  
}

创建Markdown模板

  1. Ctrl+Shift+P搜索snippets,选择配置用户代码片段。
  2. 创建全局Snippets文件, 将如下代码粘贴到文件的大括号中。
    "create markdown": {
        "prefix": "md", // 输入md,即显示模板提示
    	"body": [
            "---",
            "title: $1", // $1表示生成模板后,光标最先在此位置
            "date: $2", // $2表示,在$1处输入完成后,按tab键,光标便跳转到这里,以此类推
            "tags:",
            "  - $3",
            "---",
            "",
    	],
    	"description": "markdown模板"
      }
    
  3. 重启VS Code,Ctrl+N新建文本,键入md回车,生成模板文件。
posted on 2025-01-12 15:03  hsbd123  阅读(8)  评论(0)    收藏  举报