分享一個好用的VSCode頭部註解外掛：Fileheader Pro-VSCode-PHP中文網

VSCode中怎麼快速進行頭部註解？以下這篇文章跟大家分享一個好用的VSCode頭部註解外掛：Fileheader Pro，開箱即用又能完全自訂的Fileheader外掛程式您會喜歡麼？總之，非常好用就對了。加上頭部註解的事情就交給它吧！

分享一個好用的VSCode頭部註解外掛：Fileheader Pro

【推薦學習：《vscode入門教學》】

有時候需要在程式碼頭部加上像這樣的一段註釋。這段註釋包括了作者、程式碼版權授權等資訊。每次重複添加都會讓您覺得非常麻煩。作為開發者的您，時間是自然非常。那麼這個插件，就是為這個場景而生，替你無感地默默做完這件事。如果您想要在程式碼頭部添加一些類似這樣的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
 */

登入後複製

這段程式碼來自這裡：

https://github.com/IronLu233/fileheader-pro/blob/main/src/Extension.ts

安裝與使用

如何獲得它

#Fileheader Pro - Visual Studio Marketplace VSCode擴展市場，點擊Install

讓它默默添加頭部註解

檔案註解中的資訊來自於您的版本控制工具，目前插件也只支援Git，再未來它將支援SVN，Mercurial等其它版本控制工具。因此請您確保在有Git的專案中使用它。

安裝後，預設的模板將能複合大部分的使用場景。

當你新建一個檔案後，將會自動地為你新增Fileheader。因此大部分情況下您不需要下文中的手動添加

分享一個好用的VSCode頭部註解外掛：Fileheader Pro

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

分享一個好用的VSCode頭部註解外掛：Fileheader Pro

儲存時，您的檔案頭部註解需要更新時，Fileheader Pro將會自動為您更新。

分享一個好用的VSCode頭部註解外掛：Fileheader Pro

自訂模板

儘管自帶的模板能滿足大部分場景。但自訂模板的強大與整活能力，也值得為它去專門配置。

分享一個好用的VSCode頭部註解外掛：Fileheader Pro

別忘了將你的範本提交到git上，並且讓與你一起開發的同學也安裝Fileheader Pro

首先我們需要建立一個模板。在您VSCode的指令面板中，執行這樣的指令: Fileheader Pro: Generate Custom Fileheader Template;

分享一個好用的VSCode頭部註解外掛：Fileheader Pro

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

請務必將所有返回的字串使用tpl進行模板字串函數的調用，否則可能會出現一些奇怪的問題

分享一個好用的VSCode頭部註解外掛：Fileheader Pro

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

##mtime文件被修改時間。取得邏輯同authorName作者名字，會從版本控制工具歷史中尋找，如果這個檔案是新的，那麼它將會使用authorEmail作者的電子郵件信箱，回退機制同 userName使用者的名字。對於git來說，會透過#userEmail使用者的電子郵件信箱，對於git會透過companyName公司名稱。沒有公司的可以去工商局登記成立projectName#目前專案的名稱，也就是VSCode所開啟的資料夾的名稱filePath目前檔案的路徑dirPath目前檔案的目錄路徑fileName目前檔案的檔案名稱

欄位	意義
#birthtime	檔案被建立的時間，如果它被版本控制系統所追蹤那麼會從版本控制系統中獲取創建時間，否則將使用文件在磁碟中創建的時間
	birthime`，`不建議使用mtime。因為當一個檔案被多個人修改時，他們關於mtime的註釋，會在程式碼合併時造成衝突！
	userName
	authorName
	git config user.name`取得`
	git config user.email`取得`