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",
		...
	}
}

1. 接下来创建文件，发现会有提示，但是仍然是固定的，没有自己加的 description 等内容。

2. 莫慌，接下来按思路说明我们的配置。

配置方式

1. 首先默认公共参数放置在上方的 Default 对象中.

2. 那支持的文件在哪里呢，怎么配置不同类型的文件放置位置。打开插件文件夹，在 template 中会发现有 header 和 body 两个文件夹。这里就是配置文件中默认的配置参数位置。

3. 修改我们想要添加的文件类型名的内容， 增加我们的参数即可。其中有系统默认值，和我们上面设置的值，作为变量放在 {{}} 中，例如：

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

1. 如果你是前端开发，你会发现 html 的特殊性，因为你设置的时候会发现，上述形式在新建文件中并不是注释形式，显然这不符合我们的要求。
   
   而且你更改为注释形式，会发现新建将没有注释，因为没有被解析到。

解决方式，更改文件类型，使其不为注释形式。

1. 另外，可通过配置自己的文件夹作为 header 和 body， 配置方式：

"custom_template_header_path": "",