深入掌握FileHeader

一、FileHeader是什麼

FileHeader是一種代碼注釋工具，用於自動添加文件頭信息，包括文件名、作者、創建時間、修改時間等等。

在我們編寫代碼的時候，經常需要手動添加文件頭信息，這既費時又容易出錯。FileHeader的出現就是為了解決這個問題，它可以通過設置默認參數，在我們添加文件時自動添加文件頭信息，提高我們的開發效率，降低出錯率。

二、FileHeader.customer有哪些

FileHeader.customer是自定義參數，在FileHeader設置中通過「Defalut」、「Custom1」、「Custom2」等命名的參數。

我們可以通過設置好這些參數，在我們新建文件時即可自動添加對應的文件頭信息。

三、FileHeader參數

使用FileHeader的時候，我們需要了解一些參數的含義，以下是常用的參數及其含義：

/*  
 * @Author: What's your name 
 * @Date: When did you finish it 
 * @LastEditTime: When did you last edit it 
 * @LastEditors: Who changed it last time 
 * @Description: What does your code do 
 * @FilePath: Where is your code saved 
 * @version: What version is it now 
 */

其中，@Author表示作者，@Date表示創建日期，@LastEditTime表示上一次編輯時間，@LastEditors表示最後一位修改的人員，@Description表示代碼描述，@FilePath表示文件的路徑，@version表示版本號。

四、FileHeader怎麼用

我們可以通過以下步驟來使用FileHeader：

1、打開VSCode插件管理器，並搜索文件頭FileHeader插件。

2、安裝FileHeader插件後，我們需要在VSCode的設置中配置代碼片段的生成規則。

"fileheader.customMade": {
    "author": "What's your name",
    "date": "When did you finish it",
    "lastAuthor": "Who changed it last time",
    "lastDate": "When did you last edit it",
    "fileName": "${TM_FILENAME_BASE}",
    "description": "What does your code do",
    "filePath": "${TM_FILEPATH}",
    "version": "What version is it now"
}

3、在新建文件時，我們可以使用命令Ctrl+Shift+P，在彈出的命令列表中選擇「Add File Header」命令，在文件頭中自動生成代碼

五、FileHeader xosc

我們還可以通過配置VSCode的用戶設置來禁用或啟用FileHeader插件。

1、禁用FileHeader插件

我們可以在VSCode的設置中搜索FileHeader，找到插件的設置選項，在其中添加「fileheader.enable: false」代碼段即可禁用插件。

"fileheader.enable": false

2、啟用FileHeader插件

同樣，在VSCode的設置中搜索FileHeader，在其中添加「fileheader.enable: true」代碼段即可啟用插件。

"fileheader.enable": true

六、FileHeader插件禁用

在某些特殊情況下，我們可能需要禁用FileHeader插件。

我們可以通過在VSCode的用戶設置中添加以下代碼塊來禁用FileHeader插件：

"[javascript]": {
    "editor.quickSuggestions": {
        "strings": false
    },
    "editor.suggestOnTriggerCharacters": false,
    "editor.suggest.enabled": false
}

七、FileHeader是什麼意思

FileHeader翻譯過來就是文件頭信息，是指在程序代碼頭部添加的作者、時間、文件名等附加信息。

FileHeader插件可以幫助我們自動添加這些附加信息，提高生產效率。

八、FileHeader.customMade

除了默認的參數外，我們還可以使用FileHeader.customMade自定義我們需要添加的內容。在FileHeader中進行設置後，自己可以選擇一些列參數添加到代碼頭部中。

  "fileheader.customMade": {
    "test1" : "test1-value",
    "test2" : "test2-value",
    "test3" : "test3-value"
  }

九、FileHeader dismatch the type

當我們使用FileHeader插件時，如果設置的參數類型與實際類型不同，將會導致插件失效。

比如，在實際代碼中有一個參數類型為「String」，但是在插件中設置了參數類型為「array」時，插件將無法自動添加文件頭信息。

因此，我們在使用FileHeader插件時，一定要注意將參數設置正確。

十、總結

FileHeader插件的出現，解決了我們在編碼時手動添加文件頭信息的問題。它可以自動添加文件頭信息，提高我們的工作效率，降低出錯率。我們需要學會使用FileHeader插件，並且設置好對應的自定義參數，以便更好的適應我們的需求。