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

yipeiwu_com5年前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的While循环语句的使用方法

全面解析Python的While循环语句的使用方法

Python 编程中 while 语句用于循环执行程序,即在某条件下,循环执行某段程序,以处理需要重复处理的相同任务。其基本形式为: while 判断条件: 执行语句……...

python3编写C/S网络程序实例教程

本文以实例形式讲述了python3编写C/S网络程序的实现方法。具体方法如下: 本文所述实例是根据wingIDE的提示编写的一个C/S小程序,具体代码如下: client端myclien...

Python编程之Re模块下的函数介绍

re模块下的函数 compile(pattern):创建模式对象 import re pat=re.compile('A') m=pat.search('CBA')...

Python检测网络延迟的代码

本文讲述了Python检测网络延迟的代码。分享给大家供大家参考,具体如下: #!/usr/bin/env python # coding: utf-8 # coding: cp9...

Python for Informatics 第11章 正则表达式(一)

正则表达式,又称正规表示法、常规表示法(英语:Regular Expression,在代码中常简写为regex、regexp或RE),计算机科学的一个概念。正则表达式使用单个字符串来描...