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中cPickle用法例子分享
Jan 03 Python
用python写的一个wordpress的采集程序
Feb 27 Python
Python实现迭代时使用索引的方法示例
Jun 05 Python
Sanic框架安装与简单入门示例
Jul 16 Python
python得到windows自启动列表的方法
Oct 14 Python
python 实现批量xls文件转csv文件的方法
Oct 23 Python
opencv实现图片模糊和锐化操作
Nov 19 Python
简单了解python 生成器 列表推导式 生成器表达式
Aug 22 Python
Python数据处理篇之Sympy系列(五)---解方程
Oct 12 Python
如何基于python生成list的所有的子集
Nov 11 Python
Python自动发送和收取邮件的方法
Aug 12 Python
python随机打印成绩排名表
Jun 23 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计算程序运行时间的简单例子分享
2014/05/10 PHP
php定义参数数量可变的函数用法实例
2015/03/16 PHP
PHPExcel笔记, mpdf导出
2016/05/03 PHP
thinkphp5 URL和路由的功能详解与实例
2017/12/26 PHP
PHP文件后缀不强制为.php方法
2019/03/31 PHP
基于JQuery实现异步刷新的代码(转载)
2011/03/29 Javascript
JavaScript 图像动画的小demo
2012/05/23 Javascript
2012年开发人员的16款新鲜的jquery插件体验分享
2012/12/28 Javascript
JavaScript打印网页指定区域的例子
2014/05/03 Javascript
JS实现点击按钮控制Div变宽、增高及调整背景色的方法
2015/08/05 Javascript
text-align:justify实现文本两端对齐 兼容IE
2015/08/19 Javascript
清除js缓存的多种方法总结
2016/12/09 Javascript
Angular使用ng-messages与PHP进行表单数据验证
2016/12/28 Javascript
bootstrap按钮插件(Button)使用方法解析
2017/01/13 Javascript
jQuery快速高效制作网页交互特效
2017/02/24 Javascript
十大热门的JavaScript框架和库
2017/03/21 Javascript
Javascript实现基本运算器
2017/07/15 Javascript
[01:31](回顾)杀出重围,决战TI之巅
2014/07/01 DOTA
对python 矩阵转置transpose的实例讲解
2018/04/17 Python
python面试题小结附答案实例代码
2019/04/11 Python
python 下 CMake 安装配置 OPENCV 4.1.1的方法
2019/09/30 Python
win10系统下python3安装及pip换源和使用教程
2020/01/06 Python
Python with语句用法原理详解
2020/07/03 Python
Python利用matplotlib绘制折线图的新手教程
2020/11/05 Python
日本最大的购物网站:日本乐天市场(Rakuten Ichiba)
2020/11/04 全球购物
物业客服专员岗位职责
2013/11/30 职场文书
教师辞职报告范文
2014/01/20 职场文书
中学生评语大全
2014/04/18 职场文书
学校政风行风评议心得体会
2014/10/21 职场文书
幼儿园大班见习报告
2014/10/31 职场文书
布达拉宫导游词
2015/02/02 职场文书
长江七号观后感
2015/06/11 职场文书
围城读书笔记
2015/06/26 职场文书
开学第一天的感想
2015/08/10 职场文书
Maven学习----Maven安装与环境变量配置教程
2021/06/29 Java/Android
java objectUtils 使用可能会出现的问题
2022/02/28 Java/Android