如何給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)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容