如何給vscode編輯器增加author, email川抡,最初編輯時間,最后編輯時間等等file header信息

Entities should not be multiplied unnecessarily.
如無必要须尚,勿增實體崖堤。
---- 奧卡姆剃刀法則

以前一直在用vim作為編輯器,偶爾也會使用過sublime以及bluefish等等編輯器耐床。但是最近決定用vscode來寫代碼密幔,vscode是一個跨平臺(macOS, windows, linux)的代碼編輯器,并且具有豐富的插件撩轰。無意討論編輯器的好壞胯甩,編輯器的好壞不重要,寫出來的代碼質(zhì)量才是值得討論的那個堪嫂。

然而我們在編程實踐中偎箫,經(jīng)常需要在代碼中加入一些文件頭信息(File header information),比如這個代碼的作者皆串,作者郵箱淹办,代碼創(chuàng)作時間,最后修改時間等等恶复。這些信息的添加實現(xiàn)怜森,可以用一個vscode的插件,koroFileHeader來實現(xiàn)谤牡,效果圖如下圖(Figure1, Figure4)副硅。

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

  • 點擊Step1處的圖標(biāo)
  • 在搜索框中輸入koroFileHeader
  • 選中koroFileHeader插件,并點擊install.
Figure1: 安裝koroFileHeader插件

安裝好koroFileHeader插件之后翅萤,還需要配置個性化的Json格式的信息恐疲。步驟如下(Figure2):

  • 點擊File -> Preference -> Settings
  • 在出來的搜索框中輸入Fileheader
  • 點即Figure2標(biāo)紅的地方5, 進(jìn)入edit in settings.json

以我自己修改內(nèi)容為例,添加了如下內(nèi)容(Figure3)培己。更詳細(xì)的配置信息糜烹,也可以參考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腳本為例,F(xiàn)ile -> open file -> (Maybe need to be saved first) -> ctrl+alt+i快捷鍵(linux系統(tǒng))

Figure4 如何在新生成的文件中插入表頭信息阵苇,以python腳本為例

最后壁公,使用效果如上。


Done.

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末绅项,一起剝皮案震驚了整個濱河市紊册,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌快耿,老刑警劉巖囊陡,帶你破解...
    沈念sama閱讀 222,252評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異掀亥,居然都是意外死亡撞反,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,886評論 3 399
  • 文/潘曉璐 我一進(jìn)店門搪花,熙熙樓的掌柜王于貴愁眉苦臉地迎上來遏片,“玉大人,你說我怎么就攤上這事撮竿∷北悖” “怎么了?”我有些...
    開封第一講書人閱讀 168,814評論 0 361
  • 文/不壞的土叔 我叫張陵幢踏,是天一觀的道長髓需。 經(jīng)常有香客問我,道長惑折,這世上最難降的妖魔是什么授账? 我笑而不...
    開封第一講書人閱讀 59,869評論 1 299
  • 正文 為了忘掉前任,我火速辦了婚禮惨驶,結(jié)果婚禮上白热,老公的妹妹穿的比我還像新娘。我一直安慰自己粗卜,他們只是感情好屋确,可當(dāng)我...
    茶點故事閱讀 68,888評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般攻臀。 火紅的嫁衣襯著肌膚如雪焕数。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,475評論 1 312
  • 那天刨啸,我揣著相機(jī)與錄音堡赔,去河邊找鬼。 笑死设联,一個胖子當(dāng)著我的面吹牛善已,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播离例,決...
    沈念sama閱讀 41,010評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼换团,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了宫蛆?” 一聲冷哼從身側(cè)響起艘包,我...
    開封第一講書人閱讀 39,924評論 0 277
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎耀盗,沒想到半個月后想虎,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,469評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡袍冷,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,552評論 3 342
  • 正文 我和宋清朗相戀三年磷醋,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片胡诗。...
    茶點故事閱讀 40,680評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡邓线,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出煌恢,到底是詐尸還是另有隱情骇陈,我是刑警寧澤,帶...
    沈念sama閱讀 36,362評論 5 351
  • 正文 年R本政府宣布瑰抵,位于F島的核電站你雌,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏二汛。R本人自食惡果不足惜婿崭,卻給世界環(huán)境...
    茶點故事閱讀 42,037評論 3 335
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望肴颊。 院中可真熱鬧氓栈,春花似錦、人聲如沸婿着。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,519評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至提完,卻和暖如春形纺,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背徒欣。 一陣腳步聲響...
    開封第一講書人閱讀 33,621評論 1 274
  • 我被黑心中介騙來泰國打工逐样, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人打肝。 一個月前我還...
    沈念sama閱讀 49,099評論 3 378
  • 正文 我出身青樓官研,卻偏偏與公主長得像,于是被迫代替她去往敵國和親闯睹。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,691評論 2 361

推薦閱讀更多精彩內(nèi)容