告别重复：用 VS Code 代码片段打造你的专属 Python 模板

开篇：受够了复制粘贴？是时候解放双手了！

每次新建一个 Python 文件，都要手动添加 # -*- coding: utf-8 -*-，作者、日期，巴拉巴拉一大堆？2026 年了，还在做这种重复性的劳动，简直是对程序员的侮辱！

手动复制粘贴不仅浪费时间，还容易出错。更可悲的是，大多数“最佳实践”提供的模板都千篇一律，根本不符合你的实际需求。难道你不想拥有一个真正属于自己的、高度定制化的 Python 代码模板吗？

是时候拥抱自动化了！VS Code 的用户代码片段功能，就是你解放双手的利器。它可以让你根据项目类型、文件用途，甚至是当天星期几，自动应用不同的模板。别再犹豫了，跟我一起打造你的专属 Python 代码模板吧！

核心：用户代码片段，你的专属模板工厂

VS Code 的用户代码片段功能非常强大，可以让你定义各种各样的代码模板，并在需要的时候快速插入。下面，我们以 Python 为例，讲解如何使用用户代码片段。

1. 打开用户代码片段配置文件

• 打开 VS Code，按下 Ctrl + Shift + P (Windows/Linux) 或 Cmd + Shift + P (macOS)，输入 snippets，选择 首选项: 配置用户代码片段。
• 在弹出的列表中，选择 python，VS Code 会自动打开 python.json 文件。如果文件不存在，会自动创建一个。

2. 定义你的第一个 Python 代码模板

在 python.json 文件中，你可以定义多个代码模板。每个模板都包含一个名称、一个前缀和一个代码片段。例如，下面是一个简单的 Python 文件头部注释模板：

{
  "Python Header": {
    "prefix": "header",
    "body": [
      "#!/usr/bin/env python",
      "# -*- coding: utf-8 -*-",
      "# @Author: Your Name",
      "# @Date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}",
      "# @File: ${TM_FILENAME}",
      "# @Software: VS Code"
    ],
    "description": "Python 文件头部注释"
  }
}

• "Python Header": 模板的名称，可以随意起。
• "prefix": "header": 触发模板的前缀。当你在 Python 文件中输入 header 并按下 Tab 键时，VS Code 会自动插入代码片段。
• "body": 代码片段的内容。这是一个字符串数组，每一行都是代码片段的一行。
• "description": 模板的描述，用于在 VS Code 的代码提示中显示。

3. 动态变量，让你的模板更智能

VS Code 提供了很多内置的动态变量，可以让你在代码片段中插入当前日期、时间、文件名等信息。

• ${CURRENT_YEAR}: 当前年份
• ${CURRENT_MONTH}: 当前月份
• ${CURRENT_DATE}: 当前日期
• ${TM_FILENAME}: 当前文件名
• ${TM_FILENAME_BASE}: 当前文件名（不包含扩展名）
• ${TM_FILEPATH}: 当前文件路径
• ${TM_DIRECTORY}: 当前文件所在目录
• ${TM_USERNAME}: 当前用户名

你还可以使用占位符，让 VS Code 在插入代码片段后，自动将光标定位到指定位置，方便你输入内容。例如：

{
  "Python Function": {
    "prefix": "func",
    "body": [
      "def ${1:function_name}(${2:parameters}):",
      "  """${3:function_description}"""",
      "  ${4:pass}"
    ],
    "description": "Python 函数模板"
  }
}

• ${1:function_name}: 第一个占位符。function_name 是默认值，当插入代码片段后，光标会自动定位到这里，你可以直接输入函数名。
• ${2:parameters}: 第二个占位符，默认值为 parameters。
• ${3:function_description}: 第三个占位符，默认值为 function_description。
• ${4:pass}: 第四个占位符，默认值为 pass。

你可以使用 Tab 键在不同的占位符之间切换。

4. 根据文件类型应用不同的模板

如果你想根据文件类型应用不同的模板，可以使用 pathPatterns 属性。例如，下面是一个只在测试文件中应用的模板：

{
  "Python Test Header": {
    "prefix": "test_header",
    "body": [
      "import unittest",
      "",
      "class ${TM_FILENAME_BASE}(unittest.TestCase):",
      "  def test_${1:test_name}(self):",
      "    ${2:pass}"
    ],
    "description": "Python 测试文件头部注释",
    "pathPatterns": "*_test.py,test_*.py"
  }
}

• "pathPatterns": "*_test.py,test_*.py": 这个模板只会在文件名以 _test.py 或 test_*.py 结尾的文件中生效。

进阶：更智能的模板，更高的效率

1. 使用转换函数

VS Code 提供了一些转换函数，可以让你对变量进行格式化。例如，你可以使用 upcase 函数将文件名转换为大写：

{
  "Python Class Header": {
    "prefix": "class_header",
    "body": [
      "class ${TM_FILENAME_BASE/(.*)/${u:$1}/}:",
      "  """${1:Class Description}"""",
      "  def __init__(self):",
      "    ${2:pass}"
    ],
    "description": "Python 类头部注释"
  }
}

• ${TM_FILENAME_BASE/(.*)/${u:$1}/}: 这个表达式会将文件名转换为大写。/(.*)/ 是一个正则表达式，匹配整个文件名。${u:$1} 是一个转换函数，将第一个匹配到的分组转换为大写。

2. 使用条件语句（需要扩展支持）

虽然 VS Code 内置的代码片段功能不支持条件语句，但你可以使用一些扩展来实现类似的功能。例如，可以使用 Snippet Variables 扩展，它允许你在代码片段中使用 JavaScript 代码来计算变量的值。

3. 利用 VS Code 扩展增强模板功能

除了 Snippet Variables 之外，还有很多其他的 VS Code 扩展可以增强代码片段的功能。例如，可以使用 File Header Comment 扩展，它可以自动生成文件头部注释，并且支持自定义模板。

总结：定制化才是王道

不要再盲目地使用那些千篇一律的“最佳实践”了！根据自己的实际需求，定制最适合自己的 Python 代码模板，才能真正提高开发效率。VS Code 的用户代码片段功能非常强大，只要你花一点时间学习，就能打造出属于自己的专属模板工厂。赶紧行动起来，解放你的双手，告别重复劳动吧！