VS Code 自动为 Python 文件添加头部注释
发布时间：2026-10-13 |
7人浏览过
本文介绍如何在 VS Code 中通过 User Snippets 功能，为 Python 文件自动添加包含文件名、时间、作者等信息的头部注释。只需配置 python.json 文件并输入 header 前缀，即可快速生成标准注释模板，提升开发效率。
VS Code 自动添加 Python 头部注释配置
在编写 Python 文件时，通常需要添加包含文件名、功能描述、创建时间、作者及版本号等说明信息的头部注释。由于这些信息多遵循固定模板，手动输入较为繁琐。本文介绍一种在 VS Code 中自动添加此类注释的方法。
依次点击菜单栏的“File”、“Preferences”和“User Snippets”，选择“python”选项。这将生成一个 python.json 文件，需将其内容替换为以下配置代码：
{
"HEADER": {
"prefix": "header",
"body": [
"#!/usr/bin/env python",
"# -*- encoding: utf-8 -*-",
"'''",
"@文件 :$TM_FILENAME",
"@说明 :",
"@时间 :$CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
"@作者 :张三",
"@版本 :1.0",
"'''",
"",
"$0"
],
}
}
保存对 python.json 文件的修改。
新建一个 Python 文件，在文件头部输入 header 后，系统将自动弹出预设的注释模板：
若需调整注释模板内容，直接修改对应的 python.json 文件即可。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持本站。
本站声明
本文内容仅供参考，不代表本站观点。转载或引用请注明出处。如发现内容问题，请通过联系我们页面反馈。
