在 VSCode 中为 Python 文件添加美观的头部注释模板，可以通过以下几种方法实现： ### 使用用户代码片段（Snippets） VSCode 提供了用户代码片段功能，可以自定义代码模板并设置触发前缀[^2]。具体操作如下： 1. 打开命令面板：`Ctrl + Shift + P` 或 `Cmd + Shift + P`。 2. 输入 `Preferences: Configure User Snippets` 并选择。 3. 选择 `python.json` 或新建一个。 4. 添加如下格式的代码片段： ```json "HEADER": { "prefix": "header", "body": [ "#!/usr/bin/env python3", "# -*- encoding: utf-8 -*-", "", "# @File : $TM_FILENAME", "# @Time : $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND", "# @Author : H2o", "# @Version : 1.0", "# @Contact : 515430193@qq.com", "" ], "description": "Python文件头部注释模板" } ``` 输入 `header` 后按下 `Tab` 键即可插入该模板。 ### 使用插件 KoroFileHeader KoroFileHeader 是一款强大的文件头注释插件，支持自动添加和更新文件头信息[^3]。其主要功能包括： - 自动识别创建时间和最后编辑时间。 - 支持自动更新文件路径、作者等信息。 - 可以根据配置生成不同语言的头部注释。 安装插件后，在 `settings.json` 中进行如下配置： ```json { "fileheader.customMade": { "Author": "H2o", "Email": "515430193@qq.com", "Date": "Do not edit", "LastEditTime": "Do not edit", "FilePath": "Do not edit", "Description": "This file contains the main logic of the project." }, "fileheader.configObj": { "beforeAnnotation": { "py": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n" }, "autoAdd": true, "createHeader": true } } ``` ### 自定义美化模板 为了使头部注释更加美观，可以在模板中加入图标、符号或 ASCII 艺术字[^5]。例如： ```json "body": [ "#!/usr/bin/env python3", "# -*- encoding: utf-8 -*-", "'''", "@File : $TM_FILENAME", "@Time : $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND", "@Author : Yan Wen", "@Version: 1.0", "@Contact: z19040042@s.upc.edu.cn", "@License: (C)Copyright 2021-2022, Liugroup-NLPR-CASIA", "@Desc : None", "'''", "", "# here put the import lib", "$1" ] ``` 该模板使用了单引号包裹多行注释，并对字段进行了统一缩进，使视觉效果更清晰整洁。 ### 快捷键与自动化 在完成代码片段配置后，可以直接通过快捷键快速插入头部注释[^4]。例如，输入 `header` 并按 `Tab` 即可触发预设的模板。 此外，KoroFileHeader 插件还支持保存时自动更新最后编辑时间和作者信息，提升开发效率。 ---