Sublime Text 自动生成文件头部注释（版权信息）：FileHeader 插件的使用

一、效果图展示

二、FileHeader 插件安装

FileHeader 插件的安装方法和其它插件相同。下面简单述说一下：

1. 先安装一个 Package Control 插件。相信大家使用 Sublime 的话都有安装这个了
2. Preference -> Package Control -> Install Package -> FileHeader。然后就会自动安装了
3. 安装好后，能够在 Preference -> Package Settings 看到 FileHeader 即说明安装成功
4. 现在，当你新建 .cpp / .c / .java 等等文件时，已经就有头部的版权信息了

三、FileHeader 配置

也许，我们经常还需要定制化我们自己想要的头部版权信息的样式。通常我们有这些做法：

1. 修改默认的用户信息

比如用户名、邮箱这样的信息，用户名默认会取你当前电脑用户的用户名，当然我们也可以直接设置为我们想要的。

设置方式：Preferences -> Package Settings -> FileHeader -> Settings - User

此时我们会打开一个空白的文件（初始状态是空白的，如果你之前没有写过东西的话），写入以下内容即可：

{
    "Default": {
        "author": "afei",
        "email": "[email protected]"
    }
}

设置符合 JSON 字符串的语法。

2. 添加一些我自己想要的注释内容

比如邮箱，当我们新建 cpp 文件时，默认头部的版本信息注释里是没有邮箱信息，那怎么做呢。

步骤：Preferences -> Browse Packages... -> FileHeader -> template -> header

此时我们可以看到很多 .tmpl 文件，例如我们想要自定义的是 .cpp 文件的头部注释，那么我们就选择 C++.tmpl 文件使用文本编辑器打开，修改如下：

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

当然，这里只是提供一个参考，注释的内容可以自己随意 DIY。

想要修改其它 Java 等文件的注释信息的话，对应修改其 .tmpl 文件即可。

四、扩展

当我在新建 .h / .hpp 文件时，发现并没有生成对应的头部注释信息，那么要怎么办呢？

其实我们只需要简单的修改一下它的 Python 代码就可以完成这个需求了。

步骤：Preferences -> Browse Packages... -> FileHeader -> FileHeader.py

文件编辑器打开 FileHeader.py 后，我们可以在 31 行的位置看到一个叫做 FILE_SUFFIX_MAPPING 的键值对信息，顾名思义，就是它定义的文件后缀名映射到不同语法的信息。所以，我们如果想要 .h / .hpp 变得像 .c / .cpp 一样。可以添加这样两行

    ... # 省略
    "bat": "Batch File",
    "cmd": "Batch File",
    "c": "C",
    "h": "C", # 添加这一行
    "cs": "C#",
    "cpp": "C++",
    "hpp": "C++", # 还有这一行
    "clj": "Clojure",
    "css": "CSS",
    "D": "D",
    ... # 省略