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

yipeiwu_com7年前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设计】。

相关文章

精确查找PHP WEBSHELL木马的方法(1)

精确查找PHP WEBSHELL木马的方法(1)

先来看下反引号可以成功执行命名的代码片段。代码如下: 复制代码 代码如下: `ls -al`; `ls -al`; echo "sss"; `ls -al`; $sql = "SELEC...

Python运维自动化之nginx配置文件对比操作示例

Python运维自动化之nginx配置文件对比操作示例

本文实例讲述了Python运维自动化之nginx配置文件对比操作。分享给大家供大家参考,具体如下: 文件差异对比diff.py #!/usr/bin/env python # imp...

解决python报错MemoryError的问题

如下: python 32bit 最大只能使用 2G 内存,坑爹之处,超过 2G 报错MemoryError。 而 64bit python则无此限制,所以建议使用 64bit pyth...

使用sklearn之LabelEncoder将Label标准化的方法

LabelEncoder可以将标签分配一个0—n_classes-1之间的编码 将各种标签分配一个可数的连续编号: >>> from sklearn import...

Python设计模式之享元模式原理与用法实例分析

Python设计模式之享元模式原理与用法实例分析

本文实例讲述了Python设计模式之享元模式原理与用法。分享给大家供大家参考,具体如下: 享元模式(Flyweight Pattern):运用共享技术有效地支持大量细粒度的对象. 下面是...