VSCode中自动为Python文件添加头部注释

更新时间：2019年11月14日 10:08:32 作者：冰海228

这篇文章主要介绍了VSCode中自动为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文件即可。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

Python实现矩阵转置的几种方法详解
这篇文章主要介绍了Python实现矩阵转置的几种方法详解,zip() 函数用于将可迭代的对象作为参数,将对象中对应的元素打包成一个个元组,然后返回由这些元组组成的对象,这样做的好处是节约了不少的内存,需要的朋友可以参考下
2023-08-08
Python使用min、max函数查找二维数据矩阵中最小、最大值的方法
这篇文章主要介绍了Python使用min、max函数查找二维数据矩阵中最小、最大值的方法,涉及Python矩阵生成、遍历、查找等相关操作技巧,需要的朋友可以参考下
2018-05-05
python 生成器生成杨辉三角的方法(必看)
下面小编就为大家带来一篇python 生成器生成杨辉三角的方法(必看)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-04-04
深入解析Python中的descriptor描述器的作用及用法
在Python中描述器也被称为描述符,描述器能够实现对对象属性的访问控制,下面我们就来深入解析Python中的descriptor描述器的作用及用法
2016-06-06
python实现爬山算法的思路详解
爬山算法会收敛到局部最优，解决办法是初始值在定义域上随机取乱数100次，总不可能100次都那么倒霉。这篇文章主要介绍了python实现爬山算法的思路详解,需要的朋友可以参考下
2019-04-04
Python遍历pandas数据方法总结
本篇文章给大家详细介绍了Python中遍历pandas数据方法以及相关注意点，对此有兴趣的朋友参考学习下吧。
2018-02-02
Django中ORM表的创建和增删改查方法示例
这篇文章主要给大家介绍了关于Django中ORM表的创建和增删改查等基本操作的方法，还给大家分享了django orm常用查询筛选的相关内容，分享出来供大家参考学习，需要的朋友们下面随着小编来一起学习学习吧。
2017-11-11
python爬取百度贴吧前1000页内容（requests库面向对象思想实现）
这篇文章主要介绍了python爬取百度贴吧前1000页内容（requests库面向对象思想实现）,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-08-08
pandas DataFrame行或列的删除方法的实现示例
这篇文章主要介绍了pandas DataFrame行或列的删除方法的实现示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-08-08
使用pytorch搭建AlexNet操作(微调预训练模型及手动搭建)
今天小编就为大家分享一篇使用pytorch搭建AlexNet操作(微调预训练模型及手动搭建)，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-01-01