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中将两个或多个list合成一个list的方法小结

    Python中将两个或多个list合成一个list的方法小结

    python中,list这种数据结构很常用到,如果两个或者多个list结构相同,内容类型相同,我们通常会将两个或者多个list合并成一个,这样我们再循环遍历的时候就可以一次性处理掉了
    2019-05-05
  • jupyter lab无法导入graphviz模块方式

    jupyter lab无法导入graphviz模块方式

    今天小编就为大家分享一篇jupyter lab无法导入graphviz模块方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-02-02
  • 如何更改jupyter的默认文件路径

    如何更改jupyter的默认文件路径

    这篇文章主要介绍了如何更改jupyter的默认文件路径问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • python爬虫可以爬什么

    python爬虫可以爬什么

    在本篇文章里小编给大家整理的是关于python爬虫的作用地方以及相关知识点,需要的朋友们可以学习下。
    2020-06-06
  • Python如何在脚本中设置环境变量

    Python如何在脚本中设置环境变量

    环境变量是与系统进程交互的一种深入方式,它允许用户获得有关系统属性、路径和已经存在的变量的更详细信息,下面我们就来看看Python是如何通过脚本来设置环境变量的吧
    2023-10-10
  • 关于Python的pymouse click 双击的问题

    关于Python的pymouse click 双击的问题

    这篇文章主要介绍了关于Python的pymouse click 双击的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • pycharm修改主题颜色和注释颜色的详细图文教程

    pycharm修改主题颜色和注释颜色的详细图文教程

    PyCharm是一款强大的Python编辑器,相信很多人都已经用上了它,这篇文章主要给大家介绍了关于pycharm修改主题颜色和注释颜色的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2024-04-04
  • Python聚类算法之凝聚层次聚类实例分析

    Python聚类算法之凝聚层次聚类实例分析

    这篇文章主要介绍了Python聚类算法之凝聚层次聚类的原理与具体使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-11-11
  • Python使用Dash开发网页应用的方法详解

    Python使用Dash开发网页应用的方法详解

    本文主要是通过Dash的Checklist组件,简单介绍使用Dash开发的Web应用,文中的示例代码讲解详细,具有一定的借鉴价值,需要的可以参考一下
    2022-09-09
  • python编写分类决策树的代码

    python编写分类决策树的代码

    这篇文章主要为大家详细介绍了python编写分类决策树的代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-12-12

最新评论