返回 导航

其他

hangge.com

VSCode - 创建、使用代码片段教程(附Snippet共享同步方法)

作者:hangge | 2025-12-01 08:37
    VSCode 的代码片段(snippets)功能可以帮助我们快速插入常用模板、函数签名、组件骨架等,从而提高编码效率、减少重复劳动、统一项目代码风格。下面通过样例演示如何创建并使用代码片段。

1,创建代码片段

(1)首先我们编写需要生成代码片段的代码,假设我们有如下 Vue 代码想作为代码片段:
<template>
    <div class="my-component">
        <!-- 内容区域 -->
    </div>
</template>

<script>
export default {
    name: 'MyComponent',
    props: {
        // 示例:接收参数
        // msg: {
        //   type: String,
        //   default: ''
        // }
    },
    data() {
        return {
            // 本地状态
        }
    },
    // 计算属性
    computed: {

    },
    // 监听属性
    watch: {

    },
    // 初始化逻辑
    created() {

    },
    //DOM 已挂载
    mounted() {

    },
    // 方法
    methods: {

    },
}
</script>

<style scoped>
.my-component {
    /* 样式写这里 */
}
</style>

(2)我们打开 snippet-generator.app 这个网站,将需要生成代码片段的代码复制到网站的左侧面板,并添加代码片段的描述,触发代码片段的名称(如这里的 v2comp)。右边面板便会生成相应的代码片段的格式(需要复制到 VSCode 中使用)。

(3)在 VS Code 中打开 User Smippets,不同系统对应的步骤如下。
  • Windows/LinuxFile Preferences Configure Snippets
  • macOSCode -→ Preferences User Snippets

(4)打开 UserSnippets 面板后,由于我们这里创建的是 Vue 的代码片段,在输入框中输入“vue”,并选择 vue 模板。

(5)选择 vue 模板后,会打开一个名为 vue.json 的文件。接下来,将之前在网站右边面板生成的代码片段复制到 vue.json 文件中。这样一个代码片段就创建完毕了。

2,使用代码片段

(1)在任意 vue 文件中输入“v2comp

(2)按 Enter 键就可快速生成刚才定义的代码片段。

附:实现 Snippets 的共享与同步

1,通过工作区片段实现共享

(1)在项目根目录创建 .vscode 文件夹,然后在 .vscode 中创建一个片段文件。文件名随意,只要以 .code-snippets 结尾即可。假设我这里名为 vue.code-snippets

(2)然后把我们的 Snippet JSON 写进去即可。

(3)最后只要把 .vscode/vue2-snippets.code-snippets 提交到仓库即可。这样团队成员拉取后就可以共享相同片段。

2,使用 Settings Sync(设置同步)功能

(1)VSCode 内置 Settings Sync(设置同步)功能,可以同步用户 snippets 到其它机器(依赖 GitHub / Microsoft 账户)。首先在 VSCode 左下角点击账户图标,选择“Backup and Sync Setting...

(2)首次开启时会弹出对话框让我们选择同步范围,然后点击“Sign in”按钮。

(3)接着 VSCode 会让我们选择使用哪种账户进行同步,比如我这里选择 GitHub 账户。选择后浏览器会自动打开 GitHub 登录页,登录后点击授权。完成后 VSCode 会自动返回。


(4)同步开启后,VSCode 自动上传我们的设置到云端,包括:每次修改设置、每次安装 / 删除插件、每次更新 snippet 都会自动同步。当我们在另一台电脑登录 VSCode,即可把我们的配置全部同步过来。
评论

全部评论(0)

回到顶部