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处理速度原理及方法实例

这篇文章主要介绍了提升python处理速度原理及方法实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下  导读:作为日常生产开发中非常...

Python aiohttp百万并发极限测试实例分析

本文实例讲述了Python aiohttp百万并发极限测试。分享给大家供大家参考,具体如下: 本文将测试python aiohttp的极限,同时测试其性能表现,以分钟发起请求数作为指标。...

浅谈django model postgres的json字段编码问题

django model的json字段的编码器不能有效编码诸如uuid,datetime等数据类型,当直接存储此类型的对象到json字段中为抛出编码异常,这时可以通过JSONField字...

python urllib urlopen()对象方法/代理的补充说明

python urllib urlopen()对象方法/代理的补充说明 urllib 是 python 自带的一个抓取网页信息一个接口,他最主要的方法是 urlopen(),是基于 py...

Python3.0 实现决策树算法的流程

决策树的一般流程 检测数据集中的每个子项是否属于同一个分类 if so return 类标签 Else   寻找划分数据集的最好特征    ...