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 socket网络编程步骤详解(socket套接字使用)
Dec 06 Python
python从入门到精通(DAY 1)
Dec 20 Python
Python使用asyncio包处理并发详解
Sep 09 Python
python中lambda()的用法
Nov 16 Python
python如何读写json数据
Mar 21 Python
python绘制散点图并标记序号的方法
Dec 11 Python
对python dataframe逻辑取值的方法详解
Jan 30 Python
Python for循环与range函数的使用详解
Mar 23 Python
django表单的Widgets使用详解
Jul 22 Python
TensorFlow中如何确定张量的形状实例
Jun 23 Python
解决Windows下python和pip命令无法使用的问题
Aug 31 Python
5个pandas调用函数的方法让数据处理更加灵活自如
Apr 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 防恶意刷新实现代码
2010/05/16 PHP
CentOS7.0下安装PHP5.6.30服务的教程详解
2018/09/29 PHP
一个对于Array的简单扩展
2006/10/03 Javascript
javascript 精粹笔记
2010/05/09 Javascript
javascript中创建对象的三种常用方法
2010/12/30 Javascript
同域jQuery(跨)iframe操作DOM(示例代码)
2013/12/13 Javascript
在javascript中执行任意html代码的方法示例解读
2013/12/25 Javascript
node.js入门教程
2014/06/01 Javascript
最新最热最实用的15个jQuery插件汇总
2015/07/05 Javascript
jquery之别踩白块游戏的简单实现
2016/07/25 Javascript
Jquery针对tr td的一些实用操作方法(必看篇)
2016/10/05 Javascript
el表达式 写入bootstrap表格数据页面的实例代码
2017/01/11 Javascript
AngularJS基于http请求实现下载php生成的excel文件功能示例
2018/01/23 Javascript
Vue 父子组件的数据传递、修改和更新方法
2018/03/01 Javascript
vue项目中vue-i18n和element-ui国际化开发实现过程
2018/04/25 Javascript
JavaScript函数的特性与应用实践深入详解
2018/12/30 Javascript
[36:17]DOTA2上海特级锦标赛 - VGL音乐会全集
2016/03/06 DOTA
Python中使用 Selenium 实现网页截图实例
2014/07/18 Python
Python中logging模块的用法实例
2014/09/29 Python
django主动抛出403异常的方法详解
2019/01/04 Python
PyQt弹出式对话框的常用方法及标准按钮类型
2019/02/27 Python
Python Excel vlookup函数实现过程解析
2020/06/22 Python
Python实现简单的2048小游戏
2021/03/01 Python
域名注册、建站工具、网页主机、SSL证书:Dynadot
2017/01/06 全球购物
菲律宾酒店预订网站:Hotels.com菲律宾
2017/07/12 全球购物
Rakuten Kobo台湾:电子书、eReaders和Reading应用程式
2017/11/24 全球购物
Godiva巧克力英国官网:比利时歌帝梵巧克力
2018/08/28 全球购物
TALLY WEiJL法国网上商店:服装、时装及配饰
2019/08/31 全球购物
迎接领导欢迎词
2014/01/11 职场文书
适用于所有创业者的创业计划书
2014/02/05 职场文书
房地产广告词大全
2014/03/19 职场文书
小学生感恩父母演讲稿
2014/08/28 职场文书
2015公务员年度考核评语
2015/03/25 职场文书
《圆的周长》教学反思
2016/02/17 职场文书
十大最强奥特曼武器:怪兽战斗仪在榜,第五奥特之父只使用过一次
2022/03/18 日漫
MSSQL基本语法操作
2022/04/11 SQL Server