動機(jī)

有時候需要在代碼頭部添加像這樣的一段注釋。這段注釋包括了作者、代碼版權(quán)許可等信息。每次重復(fù)添加都會讓您覺得非常麻煩。作為開發(fā)者的您，時間是自然非常。那么這個插件，就是為這個場景而生，替你無感地默默做完這件事。如果您想要在代碼頭部添加一些類似這樣的ASCII Art。它也能滿足您的需求。

/*
 * @Author: IronLu233
 * @Date: 2021-03-10 12:00:00
 * Copyright ? 你的公司名字. All rights reserved.
 */

/*
#### ########   #######  ##    ## ##       ##     ##  #######   #######   #######  
 ##  ##     ## ##     ## ###   ## ##       ##     ## ##     ## ##     ## ##     ## 
 ##  ##     ## ##     ## ####  ## ##       ##     ##        ##        ##        ## 
 ##  ########  ##     ## ## ## ## ##       ##     ##  #######   #######   #######  
 ##  ##   ##   ##     ## ##  #### ##       ##     ## ##               ##        ## 
 ##  ##    ##  ##     ## ##   ### ##       ##     ## ##        ##     ## ##     ## 
#### ##     ##  #######  ##    ## ########  #######  #########  #######   #######  
 * @author        IronLu233 <lrironsora@gmail.com>
 * @date          2022-06-12 22:33:53
 */

這段代碼來自這里

安裝與使用

如何獲得它

• Fileheader Pro - Visual Studio Marketplace VSCode擴(kuò)展市場，點(diǎn)擊Install

讓它默默添加頭部注釋

文件注釋中的信息來自于您的版本控制工具，目前插件還只支持Git，再未來它將支持SVN，Mercurial等其它版本控制工具。 因此請您確保在有Git的項(xiàng)目中使用它。

安裝后，默認(rèn)的模板將能復(fù)合大部分的使用場景。

當(dāng)你新建一個文件后，將會自動地為你添加Fileheader。因此大部分情況下您不需要下文中的手動添加

如您需要手動添加到已有代碼，打開一個文件后，在您的命令面板里【您可以使用Ctrl(Mac下是Command) + Shift + P】，輸入 Fileheader Pro: Add Fileheader并按下回車，就能見到文件注釋恰如其分地加入到了您巧奪天工的代碼頭部。

保存時，您的文件頭部注釋需要更新時，F(xiàn)ileheader Pro將會自動為您更新。

自定義模板

盡管自帶的模板能滿足大部分場景。但自定義模板的強(qiáng)大與整活能力，也值得為它去專門配置。

別忘了將你的模板提交到git上，并且讓與你一起開發(fā)的同學(xué)也安裝Fileheader Pro

首先我們需要創(chuàng)建一個模板。在您VSCode的命令面板中，執(zhí)行這樣的命令: Fileheader Pro: Generate Custom Fileheader Template;

此時在項(xiàng)目的根目錄下的.vscode/fileheader.template.js。 請修改類CustomLanguageProvider。特別是它的getTemplate方法。它的返回值，就決定了您的文件頭部注釋最后的模樣。另外，languages將會決定，在那些語言的文件中它可以被使用。

請務(wù)必將所有返回的字符串使用tpl進(jìn)行模板字符串函數(shù)的調(diào)用，否則可能會出現(xiàn)一些奇奇怪怪的問題

可以使用variable中的各個字段，對其進(jìn)行加工處理，放入模板之中。 variables的字段有下列這些

Fileheader Pro源代碼本身就使用了自定義模板添加頭部注釋。

所以它也是一個例子

fileheader-pro/fileheader.template.js at main · IronLu233/fileheader-pro (github.com)

配置項(xiàng)

FileheaderPro.disableFileds

對于默認(rèn)的模板，其中的各個字段都可以通過它來禁用。禁用的字段將不會出現(xiàn)在注釋之中。 您可以在VSCode的設(shè)置界面中，對其進(jìn)行修改

默認(rèn)值是['mtime']。不建議啟用mtime。因?yàn)楫?dāng)一個文件被多個人修改時，他們關(guān)于mtime的注釋，會在代碼合并時造成沖突！

FileheaderPro.companyName

您需要在設(shè)置中，告訴插件公司的名字，因?yàn)闊o法從任何其它地方得到它！

FileheaderPro.currentUserName和FileheaderPro.currentUserEmail

這兩個字段可以直接覆蓋掉模板中的userName和userEmail變量，也會間接影響authorName和authorEmail（當(dāng)文件并未被版本控制工具追蹤的時候）

FileheaderPro.dateFormat

注釋中的日期的格式。請參考：momentjs.com/docs/#/disp…

FileheaderPro.autoInsertOnCreateFile

是否啟用創(chuàng)建文件時，自動添加文件頭部注釋。默認(rèn)它是開啟的

FileheaderPro.autoUpdateOnSave

是否保存時更新fileheader。默認(rèn)啟用。

Fileheader Pro內(nèi)部只在需要的時候更新文件頭部注釋。

Q & A

它是怎么實(shí)現(xiàn)的？

使用了ES6的tagged template。

我們可以知道哪一些是固定的字符串，哪一些是用戶所使用的變量。接下來請參考這個抽象類

fileheader-pro/FileheaderLanguageProvider.ts at main · IronLu233/fileheader-pro (github.com)

沒有我支持的語言

目前支持這些語言

• Javascript
• Typescript
• Python
• HTML
• CSS
• Vue
• Java 請使用自定義模板，或者發(fā)起一個issue。當(dāng)然，也歡迎提PR來為Fileheader Pro添磚加瓦

以上就是好用的VSCode頭部注釋插件Fileheader Pro的詳細(xì)內(nèi)容，更多關(guān)于VSCode頭部注釋Fileheader Pro的資料請關(guān)注腳本之家其它相關(guān)文章！

最新評論