FileHeader 詳解文件頭部注釋-sublimeText

FileHeader

前言：

直奔主題吧，sublimeText 的大部分插件都是非常好用，易用的，而且很容易找到資料。這次用 FileHeader 發現網上的資料很少，而且大部分說得都很模糊，或者直接使用。

---

看了下插件的配置和 github, 實現了自己想要使用的功能，這里給大家分享一下吧（如果你也在找的話）：

安裝插件（提一嘴）

1. ctrl + shift + p

2. install package

3. FileHeader

安裝成功后配置：

1. 打開 Preference -> Package Setting -> Setting Default

2. 打開 Preference -> Package Setting -> Setting User

3. 一般我們把自己的配置放在 user 中：

4. 設置自己的默認參數。

{
	"Default": {
		"author":"xxx",
		"description": "xxx",
		...
	}
}

4. 接下來創建文件，發現會有提示，但是仍然是固定的，沒有自己加的 description 等內容。

5. 莫慌，接下來按思路說明我們的配置。

配置方式

1. 首先默認公共參數放置在上方的 Default 對象中.

2. 那支持的文件在哪里呢，怎么配置不同類型的文件放置位置。打開插件文件夾，在 template 中會發現有 header 和 body 兩個文件夾。這里就是配置文件中默認的配置參數位置。

3. 修改我們想要添加的文件類型名的內容， 增加我們的參數即可。其中有系統默認值，和我們上面設置的值，作為變量放在 {{}} 中，例如：

/*
* @Author: {{author}}
* @Date:   {{create_time}}
* @Last Modified by:   {{last_modified_by}}
* @Last Modified time: {{last_modified_time}}
*/

4. 如果你是前端開發，你會發現 html 的特殊性，因為你設置的時候會發現，上述形式在新建文件中並不是注釋形式，顯然這不符合我們的要求。
   而且你更改為注釋形式，會發現新建將沒有注釋，因為沒有被解析到。

解決方式，更改文件類型，使其不為注釋形式。

5. 另外，可通過配置自己的文件夾作為 header 和 body， 配置方式：

"custom_template_header_path": "",