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


Posted in Python onNovember 14, 2019

在实际编写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即可自动弹出下面的注释:

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

如果需要修改模板,只需要修改对应的python.json文件即可。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python BeautifulSoup中文乱码问题的2种解决方法
Apr 22 Python
Python3基础之基本数据类型概述
Aug 13 Python
django 常用orm操作详解
Sep 13 Python
Django中的Signal代码详解
Feb 05 Python
PyQt QListWidget修改列表项item的行高方法
Jun 20 Python
pygame实现烟雨蒙蒙下彩虹雨
Nov 11 Python
python实现图片上添加图片
Nov 26 Python
Python列表切片常用操作实例解析
Dec 16 Python
利用python生成照片墙的示例代码
Apr 09 Python
python 如何停止一个死循环的线程
Nov 24 Python
对PyTorch中inplace字段的全面理解
May 22 Python
关于python中readlines函数的参数hint的相关知识总结
Jun 24 Python
python中的函数递归和迭代原理解析
Nov 14 #Python
使用python实现对元素的长截图功能
Nov 14 #Python
Pycharm创建项目时如何自动添加头部信息
Nov 14 #Python
python3实现单目标粒子群算法
Nov 14 #Python
python socket 聊天室实例代码详解
Nov 14 #Python
python中dict()的高级用法实现
Nov 13 #Python
python实现的多任务版udp聊天器功能案例
Nov 13 #Python
You might like
PHP中的类型约束介绍
2015/05/11 PHP
PHP设置进度条的方法
2015/07/08 PHP
PHP实现递归目录的5种方法
2016/10/27 PHP
php unlink()函数使用教程
2018/07/12 PHP
PHP类与对象后期静态绑定操作实例详解
2018/12/20 PHP
jquery插件jbox使用iframe关闭问题
2009/02/09 Javascript
jquery下异步提交表单 异步跨域提交表单
2010/11/17 Javascript
javascript椭圆旋转相册实现代码
2012/01/16 Javascript
Javascript表格翻页效果实现思路及代码
2013/08/23 Javascript
jquery查找tr td 示例模拟
2014/05/08 Javascript
JS实现文字放大效果的方法
2015/03/03 Javascript
详解JavaScript设计模式开发中的桥接模式使用
2016/05/18 Javascript
bootstrap输入框组代码分享
2016/06/07 Javascript
JavaScript中 this 指向问题深度解析
2017/02/21 Javascript
微信小程序 首页制作简单实例
2017/04/07 Javascript
JS实现微信摇一摇原理解析
2017/07/22 Javascript
jquery.uploadView 实现图片预览上传功能
2017/08/10 jQuery
十个免费的web前端开发工具详细整理
2017/09/18 Javascript
Vue组件的使用教程详解
2018/01/05 Javascript
对vuejs的v-for遍历、v-bind动态改变值、v-if进行判断的实例讲解
2018/08/27 Javascript
Element-ui DatePicker显示周数的方法示例
2019/07/19 Javascript
JS sort方法基于数组对象属性值排序
2020/07/10 Javascript
[16:21]教你分分钟做大人:圣堂刺客
2014/12/03 DOTA
[50:24]VGJ.S vs Pain 2018国际邀请赛小组赛BO2 第二场 8.17
2018/08/20 DOTA
简单介绍使用Python解析并修改XML文档的方法
2015/10/15 Python
神经网络理论基础及Python实现详解
2017/12/15 Python
python主要用于哪些方向
2020/07/05 Python
Python+MySQL随机试卷及答案生成程序的示例代码
2021/02/01 Python
Jabra捷波朗美国官网:用于办公、车载和运动的无线蓝牙耳麦
2017/02/01 全球购物
交通事故赔偿协议书范本
2014/04/15 职场文书
歌颂祖国的演讲稿
2014/05/04 职场文书
2014学习优秀共产党员先进事迹材料思想汇报
2014/09/14 职场文书
综合测评自我评价
2015/03/06 职场文书
2015年收银工作总结范文
2015/04/01 职场文书
兴趣班停课通知
2015/04/24 职场文书
导游词之安徽九华山
2019/09/18 职场文书