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 相关文章推荐
安装dbus-python的简要教程
May 05 Python
Win10下Python环境搭建与配置教程
Nov 18 Python
Python探索之Metaclass初步了解
Oct 28 Python
python使用标准库根据进程名如何获取进程的pid详解
Oct 31 Python
快速解决pandas.read_csv()乱码的问题
Jun 15 Python
python中time库的实例使用方法
Oct 31 Python
pytorch的batch normalize使用详解
Jan 15 Python
python读取dicom图像示例(SimpleITK和dicom包实现)
Jan 16 Python
使用Matplotlib绘制不同颜色的带箭头的线实例
Apr 17 Python
Python实现CAN报文转换工具教程
May 05 Python
Python基于numpy模块实现回归预测
May 14 Python
python可视化大屏库big_screen示例详解
Nov 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编程语言开发动态WAP页面
2006/10/09 PHP
PHP 魔术函数使用说明
2010/05/14 PHP
php中的抽象方法和抽象类
2017/02/14 PHP
php封装json通信接口详解及实例
2017/03/07 PHP
Laravel中encrypt和decrypt的实现方法
2017/09/24 PHP
PHP实现一个限制实例化次数的类示例
2019/09/16 PHP
JavaScript入门教程(11) js事件处理
2009/01/31 Javascript
jquery应该如何来设置改变按钮input的onclick事件
2012/12/10 Javascript
javascript中文本框中输入法切换的问题
2013/12/10 Javascript
js 判断图片是否加载完以及实现图片的预下载
2014/08/14 Javascript
JavaScript及jquey实现多个数组的合并操作
2014/09/06 Javascript
JavaScript显示表单内元素数量的方法
2015/04/02 Javascript
JS实现的仿东京商城菜单、仿Win右键菜单及仿淘宝TAB特效合集
2015/09/28 Javascript
JavaScript String 对象常用方法详解
2016/05/13 Javascript
详解js中Json的语法与格式
2016/11/22 Javascript
ES6学习之变量的解构赋值
2017/02/12 Javascript
JavaScript获取移动设备型号的实现代码(JS获取手机型号和系统)
2018/03/10 Javascript
jQuery实现的两种简单弹窗效果示例
2018/04/18 jQuery
js实现漂亮的星空背景
2019/11/01 Javascript
解决node.js含有%百分号时发送get请求时浏览器地址自动编码的问题
2019/11/20 Javascript
浅谈python中的变量默认是什么类型
2016/09/11 Python
Python按钮的响应事件详解
2019/03/04 Python
Python 实例方法、类方法、静态方法的区别与作用
2019/08/14 Python
Python 自动登录淘宝并保存登录信息的方法
2019/09/04 Python
pandas按行按列遍历Dataframe的几种方式
2019/10/23 Python
Python使用pickle进行序列化和反序列化的示例代码
2020/09/22 Python
Python 排序最长英文单词链(列表中前一个单词末字母是下一个单词的首字母)
2020/12/14 Python
HTML5 背景的显示区域实现
2020/07/09 HTML / CSS
JAKO-O德国野酷台湾站:德国首屈一指的婴幼童用品品牌
2019/01/14 全球购物
工作自我评价分享
2013/12/01 职场文书
会计电算化专业毕业生自荐信
2013/12/20 职场文书
班主任远程培训研修日志
2015/11/13 职场文书
竞聘开场白方式有哪些?
2019/08/28 职场文书
Go语言操作数据库及其常规操作的示例代码
2021/04/21 Golang
Python爬虫中urllib3与urllib的区别是什么
2021/07/21 Python
Java+swing实现抖音上的表白程序详解
2022/06/25 Java/Android