在实际编写Python文件时，往往需要为文件添加相关说明，例如文件名称、文件作用、创建时
在实际编写Python文件时，往往需要为文件添加相关说明，例如文件名称、文件作用、创建时间、作者信息、版本号等等。这些信息往往是固定模板的，因此希望有一种方式可以自动的为我们添加上这些信息。下面介绍一种在VS Code中自动为python文件添加头部注释的方法。
依次单击菜单栏 “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文件，然后在头部敲入header即可自动弹出下面的注释：
如果需要修改模板，只需要修改对应的python.json文件即可。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
VSCode Python添加头部注释 VSCode Python 头部注释