VsCode设置python文件模板，自动添加文件头注释

1.背景

每次写python代码的时候，都要手动在文件开头加上python解释器路径，文件编码，作者，日期等一堆信息，感觉非常麻烦。作为一个程序员，要学会偷懒。

2.环境信息

• windows11 64位操作系统
• VsCode 1.81.1

3.如何设置代码模板

避免每次新建项目文件时添加注释文件名、作者、创建日期等信息，则可以设置较好的代码模板，在创建文件时自动生成相关信息。

3.1 设置步骤：

打开VsCode依次单击菜单栏 文件（File）–>首选项（Preferences）–>配置用户代码片段（User Snippets）

然后输入框中输入python后会生成python.json文件

将该文件内容替换为以下内容：

{
	"HEADER":{"prefix": "header",
		  "body": [
		  "#!/usr/bin/env python",
		  "# -*- coding: utf-8 -*-",
		  "'''",
		  "@File    :   $TM_FILENAME",
		  "@Time    :   $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
		  "@Author  :   MoTao ",
		  "@Version :   1.0",
		  "@Desc    :   None",
		  "'''",
		  "",
		  
		  "$0"
	  ],
  
	}
  }
  

模板填写好之后，保存即可。

3.2 文件模板效果如下：

新建一个python文件，然后在头部敲入header即可自动弹出下面的注释：

根据个人喜好还可以有不同的添加、设计，只需要修改对应的python.json文件即可。

最后，赶紧来设置你自己的文件模板吧！