如何给vscode编辑器增加author, email,最初编辑时间,最后编辑时间等等file header信息

Entities should not be multiplied unnecessarily.
如无必要,勿增实体。
---- 奥卡姆剃刀法则

以前一直在用vim作为编辑器,偶尔也会使用过sublime以及bluefish等等编辑器。但是最近决定用vscode来写代码,vscode是一个跨平台(macOS, windows, linux)的代码编辑器,并且具有丰富的插件。无意讨论编辑器的好坏,编辑器的好坏不重要,写出来的代码质量才是值得讨论的那个。

然而我们在编程实践中,经常需要在代码中加入一些文件头信息(File header information),比如这个代码的作者,作者邮箱,代码创作时间,最后修改时间等等。这些信息的添加实现,可以用一个vscode的插件,koroFileHeader来实现,效果图如下图(Figure1, Figure4)。

安装koroFileHeader插件只需要三步(Figure1):

  • 点击Step1处的图标
  • 在搜索框中输入koroFileHeader
  • 选中koroFileHeader插件,并点击install.
Figure1: 安装koroFileHeader插件

安装好koroFileHeader插件之后,还需要配置个性化的Json格式的信息。步骤如下(Figure2):

  • 点击File -> Preference -> Settings
  • 在出来的搜索框中输入Fileheader
  • 点即Figure2标红的地方5, 进入edit in settings.json

以我自己修改内容为例,添加了如下内容(Figure3)。更详细的配置信息,也可以参考github上该koroFileHeader插件作者的wiki文档

Figure2 更改koroFileHeader插件里的个性化配置信息

我自己添加的json配置文本:

{
    "fileheader.configObj": 
        {
        "beforeAnnotation": 
            {"py": "#!/usr/bin/env python\n# coding=utf-8" 
            }
        },


    "fileheader.customMade": 
        {"Author":"xuzhongtian",
        "LastEditors":"Xu Zhongtian",
        "email": "xuzhongtian11@163.com",
        "github": "https://github.com/BiocompZTXu",
        "Date":"Do not edit",
        "LastEditTime": "Do not edit",
        "motto": "Still water run deep",
        "Description":"Modify here please",
        "FilePath": "Do not edit"
        }, 


    "explorer.confirmDelete": false
}
Figure3 以个人的为例,举例说明如何修改json格式的配置信息

在修改配置文件之后,最后一个问题就是,怎么使用这个插件: ctrl+alt+i快捷键

使用方法也非常简单,以python脚本为例,File -> open file -> (Maybe need to be saved first) -> ctrl+alt+i快捷键(linux系统)

Figure4 如何在新生成的文件中插入表头信息,以python脚本为例

最后,使用效果如上。


Done.

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,366评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,521评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,689评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,925评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,942评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,727评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,447评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,349评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,820评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,990评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,127评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,812评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,471评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,017评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,142评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,388评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,066评论 2 355

推荐阅读更多精彩内容