# koroFileHeader使用

[koroFileHeader](https://github.com/OBKoro1/koro1FileHeader)用于在文本头部添加注释，也可以给函数添加注释。

## 一、用法

1. `VS Code`安装`koro1FileHeader`;
2. Ctrl+Shift+P，输入settings，选择`Preference:Open Settings(JSON)`，在`JSON`配置文件中添加：

   ```javascript
    "fileheader.customMade": {
        "Author":"Rodney Cheung",
        "Date": "Do not edit", // 文件创建时间(不变)
        "LastEditors": "Rodney Cheung", // 文件最后编辑者
        "LastEditTime": "Do not edit", // 文件最后编辑时间
        "FilePath": "Do not edit" // 文件在项目中的相对路径 自动更新
    },
    "fileheader.cursorMode": {
        "name":"",
        "param":"",
        "return":""
    },
   ```

   `customMade`设置文件头部注释模板，`cursorMode`设置函数注释模板。

   对于`Mac OS`,使用Command+,打开settings，搜索`File Header`，点击`edit on json`，即可打开配置文件。

## 二、高级设置

高级设置参考[官方文档](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE)。