VS Code 代码片段指南: 从基础到高级技巧

Immerse

发布于 2024-09-06 17:52:56

680

发布于 2024-09-06 17:52:56

文章被收录于专栏：非同质前端札记

前言

今天咱们来聊聊 VS Code 里的自定义代码片段。

这玩意儿简直是提升编码效率的神器, 用好了能让你敲代码更方便!

不管你是刚入行的菜鸟还是身经百战的老兵,这篇攻略都能让你在代码片段的世界里玩得飞起。

系好安全带,我们开始起飞啦!

代码片段是啥玩意儿?

简单说, 代码片段就是一些预先定义好的代码模板。你只需要敲几个字母,噌的一下,一大段代码就蹦出来了。

比如说, 你可以把一个常用的函数结构设置成代码片段,下次需要的时候,只要输入一个简短的触发词,瞬间就能生成整个函数框架。

为啥要用这玩意儿?

省时间: 再也不用重复敲那些烦人的样板代码了。
少出错: 预先定义好的代码片段能避免一些低级错误。
保持一致: 团队可以共用一套代码片段,保证代码风格统一。
提高效率: 快速生成复杂的代码结构,让你专注于真正的逻辑实现。

怎么整一个自己的代码片段?

来, 跟我一步步来:

打开 VS Code,按下 Ctrl+Shift+P(Mac 上是 Cmd+Shift+P)。
输入 "snippets",选择 Preferences: Configure User Snippets。
选你要创建片段的语言,比如 JavaScript 。
VS Code 会打开一个 JSON 文件,这就是你的代码片段配置文件。

来看个例子:

{
    "Console log": {
        "prefix": "clog",
        "body": ["console.log('$1');", "$2"],
        "description": "打印日志到控制台"
    }
}

这里的 "Console log" 是这个片段的名字,"prefix" 是触发词,"body" 是实际的代码内容,"description" 是描述。

进阶技巧

好了, 基础的东西我们搞定了。

现在来点更进阶的吧!

1. 占位符和制表位

占位符是代码片段中最基本也是最强大的功能之一。它们不仅可以让你在插入片段后快速跳转到特定位置, 还能实现更多花样。

基本占位符:

1, 2, 3 等:这些是最简单的占位符。插入片段后,光标会先停在 1 的位置,按 Tab 键后跳到
0:这是最后一个制表位。无论你定义了多少个占位符,0 永远是终点站。

来个例子:

"Basic Function": {
  "prefix": "func",
  "body": [
    "function ${1:functionName}(${2:params}) {",
    "\t$0",
    "}"
  ],
  "description": "创建一个基本函数"
}

占位符中的默认值: 你可以在占位符中提供默认值,格式是 ${1:defaultValue} 。

"Console Log": {
  "prefix": "clog",
  "body": "console.log('${1:你好,世界!}');",
  "description": "打印日志,带默认值"
}

占位符中的选择项: 你还可以在占位符中提供多个选项,让用户选择。格式是 ${1|option1,option2,option3|} 。

"Variable Declaration": {
  "prefix": "vard",
  "body": "${1|const,let,var|} ${2:变量名} = ${3:值};",
  "description": "声明变量,可选择const/let/var"
}

2. 变量

VS Code 提供了不少内置变量,可以在代码片段中使用。这些变量会在插入片段时被实际值替换。

常用内置变量:

$TM_FILENAME: 当前文件的文件名
$TM_FILENAME_BASE: 当前文件的文件名(不含扩展名)
$TM_DIRECTORY: 当前文件所在的目录
$TM_FILEPATH: 当前文件的完整文件路径
$CLIPBOARD: 当前剪贴板中的内容
$WORKSPACE_NAME: 打开的工作区的名称

日期和时间变量:

$CURRENT_YEAR: 当前年份
$CURRENT_MONTH: 当前月份(两位数格式)
$CURRENT_DATE: 当前日期(两位数格式)
$CURRENT_HOUR: 当前小时(24 小时制)
$CURRENT_MINUTE: 当前分钟
$CURRENT_SECOND: 当前秒数

来个实用的例子:

"File Header": {
  "prefix": "header",
  "body": [
    "/**",
    " * 文件名: $TM_FILENAME",
    " * 创建时间: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
    " * 作者: ${1:$TM_USERNAME}",
    " * 描述: ${2:这里写文件描述}",
    " */"
  ],
  "description": "插入文件头注释"
}

使用结果：

/**
 * 文件名: app.js
 * 创建时间: 2023-08-29 15:30:00
 * 作者: YourUsername
 * 描述: 这里写文件描述
 */

3. 转换

你还可以对变量和占位符的值进行各种花式操作。这些转换可以改变文本的大小写、格式等。

案例转换:

{VAR/(.*)/{1:/upcase}}:转换为大写
{VAR/(.*)/{1:/downcase}}:转换为小写
{VAR/(.*)/{1:/pascalcase}}:转换为帕斯卡命名法(PascalCase)
{VAR/(.*)/{1:/camelcase}}:转换为驼峰命名法(camelCase)

来个实用的例子:

"React Component": {
  "prefix": "rcomp",
  "body": [
    "import React from 'react';",
    "",
    "const ${TM_FILENAME_BASE/(.*)/${1:/pascalcase}/} = () => {",
    "\treturn (",
    "\t\t<div>",
    "\t\t\t$0",
    "\t\t</div>",
    "\t);",
    "};",
    "",
    "export default ${TM_FILENAME_BASE/(.*)/${1:/pascalcase}/};"
  ],
  "description": "创建 React 组件,自动使用文件名作为组件名"
}

使用结果：

import React from 'react';

const App = () => {
    return <div>$0</div>;
};

export default App;

这个例子会自动把文件名转换为 PascalCase,完美符合 React 组件命名规范。

4. 嵌套占位符

你可以在一个占位符内部再塞一个占位符,这就是嵌套占位符。这招能让你创建更复杂的交互式代码片段。

来个例子:

"Conditional Statement": {
  "prefix": "ifelse",
  "body": [
    "if (${1:条件}) {",
    "\t${2:// 条件成立时的代码}",
    "} else {",
    "\t${2/^(.*)$/$1/}",
    "}"
  ],
  "description": "创建 if-else 语句,自动复制 if 块的注释到 else 块"
}

使用结果：

if (条件) {
    // 条件成立时的代码
} else {
    // 条件成立时的代码
}

这个例子中,无论你在第二个占位符中输入什么,都会被自动复制到 else 块中。挺智能的,是吧?

实用的代码片段例子

光说不练假把式，来看看实际应用吧!

React Hooks 组件:

"React Hooks Component": {
  "prefix": "rhc",
  "body": [
    "import React, { useState, useEffect } from 'react';",
    "",
    "const ${1:ComponentName} = () => {",
    "\tconst [${2:state}, set${2/(.*)/${1:/capitalize}/}] = useState(${3:initialState});",
    "",
    "\tuseEffect(() => {",
    "\t\t$0",
    "\t}, []);",
    "",
    "\treturn (",
    "\t\t<div>",
    "\t\t\t{${2:state}}",
    "\t\t</div>",
    "\t);",
    "};",
    "",
    "export default ${1:ComponentName};"
  ],
  "description": "创建一个带有 useState 和 useEffect 的 React 组件"
}

使用结果

import React, { useState, useEffect } from 'react';

const ComponentName = () => {
    const [state, setState] = useState(initialState);

    useEffect(() => {}, []);

    return <div>{state}</div>;
};

export default ComponentName;

异步函数:

"Async Function": {
  "prefix": "afn",
  "body": [
    "async function ${1:functionName}(${2:params}) {",
    "\ttry {",
    "\t\tconst result = await ${3:asyncOperation};",
    "\t\treturn result;",
    "\t} catch (error) {",
    "\t\tconsole.error('Error in ${1:functionName}:', error);",
    "\t\tthrow error;",
    "\t}",
    "}"
  ],
  "description": "创建一个带有错误处理的异步函数"
}