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二进制文件转换为文本文件的代码实现

    在日常编程中,我们经常会遇到需要将二进制文件转换为文本文件的情况,在Python中,我们可以利用各种库和技术来完成这项任务,本文将介绍如何使用Python将二进制文件转换为文本文件,并提供实用的代码示例,需要的朋友可以参考下
    2024-04-04
  • Python之——生成动态路由轨迹图的实例

    Python之——生成动态路由轨迹图的实例

    今天小编就为大家分享一篇Python之——生成动态路由轨迹图的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-11-11
  • Python使用functools实现注解同步方法

    Python使用functools实现注解同步方法

    这篇文章主要介绍了Python使用functools实现注解同步方法,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2018-02-02
  • Python中使用ElementTree解析XML示例

    Python中使用ElementTree解析XML示例

    这篇文章主要介绍了Python中使用ElementTree解析XML示例,本文同时讲解了XML基本概念介绍、XML几种解析方法和ElementTree解析实例,需要的朋友可以参考下
    2015-06-06
  • python中的print(f'')具体用法例子

    python中的print(f'')具体用法例子

    在Python中f-string是一种字符串格式化的方式,它允许你在字符串中嵌入变量或表达式的值,这篇文章主要给大家介绍了关于python中print(f'')具体用法例子的相关资料,需要的朋友可以参考下
    2024-05-05
  • Django框架验证码用法实例分析

    Django框架验证码用法实例分析

    这篇文章主要介绍了Django框架验证码用法,结合实例形式分析了Python Django框架验证码的功能、实现方法及相关操作技巧,需要的朋友可以参考下
    2019-05-05
  • 在python中利用KNN实现对iris进行分类的方法

    在python中利用KNN实现对iris进行分类的方法

    今天小编就为大家分享一篇在python中利用KNN实现对iris进行分类的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-12-12
  • python如何实现单向链表及单向链表的反转

    python如何实现单向链表及单向链表的反转

    这篇文章主要介绍了python如何实现单向链表及单向链表的反转,帮助大家更好的理解和学习使用python,感兴趣的朋友可以了解下
    2021-03-03
  • python3写的简单本地文件上传服务器实例

    python3写的简单本地文件上传服务器实例

    今天小编就为大家分享一篇python3写的简单本地文件上传服务器实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-06-06
  • 快速进修Python指南之控制if-else循环技巧

    快速进修Python指南之控制if-else循环技巧

    这篇文章主要为大家介绍了Java开发者的Python快速进修指南之控制之if-else和循环技巧示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-12-12

最新评论