快捷導(dǎo)航

好用的VSCode頭部注釋插件Fileheader?Pro

更新時(shí)間：2022年07月14日 09:06:53 作者：IronLu233

這篇文章主要為大家介紹了VSCode頭部注釋插件Fileheader?Pro的使用示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

動(dòng)機(jī)

有時(shí)候需要在代碼頭部添加像這樣的一段注釋。這段注釋包括了作者、代碼版權(quán)許可等信息。每次重復(fù)添加都會讓您覺得非常麻煩。作為開發(fā)者的您，時(shí)間是自然非常。那么這個(gè)插件，就是為這個(gè)場景而生，替你無感地默默做完這件事。如果您想要在代碼頭部添加一些類似這樣的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)你新建一個(gè)文件后，將會自動(dòng)地為你添加Fileheader。因此大部分情況下您不需要下文中的手動(dòng)添加

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

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

自定義模板

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

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

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

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

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

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

字段	含義
birthtime	文件被創(chuàng)建的時(shí)間，如果它被版本控制系統(tǒng)所追蹤那么會從版本控制系統(tǒng)中獲取創(chuàng)建時(shí)間，否則將使用文件在磁盤中創(chuàng)建的時(shí)間
mtime	文件被修改時(shí)間。獲取邏輯同birthime，不建議使用mtime。因?yàn)楫?dāng)一個(gè)文件被多個(gè)人修改時(shí)，他們關(guān)于mtime的注釋，會在代碼合并時(shí)造成沖突！
authorName	作者名字，會從版本控制工具歷史中尋找，如果這個(gè)文件是新的，那么它將會使用userName
authorEmail	作者的電子郵箱，回退機(jī)制同authorName
userName	用戶的名字。對于git來說，會通過git config user.name獲取
userEmail	用戶的電子郵箱，對于git會通過git config user.email獲取
companyName	公司名稱。沒有公司的可以去工商局登記成立
projectName	當(dāng)前項(xiàng)目的名稱，也就是就是VSCode所打開的文件夾的名稱
filePath	當(dāng)前文件的路徑
dirPath	當(dāng)前文件的目錄路徑
fileName	當(dāng)前文件的文件名