# vscode文件头部注释插件

## 使用说明 <a href="#id-wen-jian-tou-bu-zhu-shi-shi-yong-shuo-ming" id="id-wen-jian-tou-bu-zhu-shi-shi-yong-shuo-ming"></a>

使用文件头部注释功能，有助于快速有效的找出最新编辑信息及创建信息

## 安装插件koroFileHeader

## 头部注释模版设置 <a href="#id-wen-jian-tou-bu-zhu-shi-tou-bu-zhu-shi-mo-ban-she-zhi" id="id-wen-jian-tou-bu-zhu-shi-tou-bu-zhu-shi-mo-ban-she-zhi"></a>

* **code-->首选项-->设置-->fileheader→搜索编辑**

### ![](https://2925742798-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lfbm7rCfl1blCD7FH_h%2F-LfbmAy1v6E5FAfscHFR%2F-LfbmDlXX3okWFWvKEax%2Ffileheader1.png?generation=1558666869915889\&alt=media) <a href="#id-wen-jian-tou-bu-zhu-shi-code-shou-xuan-xiang-she-zhi-fileheader-sou-suo-bian-ji" id="id-wen-jian-tou-bu-zhu-shi-code-shou-xuan-xiang-she-zhi-fileheader-sou-suo-bian-ji"></a>

* **右侧用户设置编辑配置内容**

```
{
    "fileheader.configObj": {
        "createFileTime": true,
        "timeNoDetail": false,
        "autoAdd": true,
        "autoAlready": true,
        "annotationStr": {
        "head": "/*",
        "middle": " * @",
        "end": " */",
        "use": true
        },
        "headInsertLine": {
        "php": 2
        }
    },
    "fileheader.cursorMode": {
        "description":"",
        "param ":"",
        "return":""
    },
    "fileheader.customMade": {
        "Description":"" ,//文件内容描述
        "Author":"name",//创建者
        "Email":"name@163.com",//邮箱
        "Date": "Do not edit",//创建时间
        "LastEditTime": "Do not edit",//最新更新时间
        "LastEditors": "name",//最新更新人
    }
}
```

### 若没有设置自动生成注释 <a href="#id-wen-jian-tou-bu-zhu-shi-ruo-mei-you-she-zhi-zi-dong-sheng-cheng-zhu-shi" id="id-wen-jian-tou-bu-zhu-shi-ruo-mei-you-she-zhi-zi-dong-sheng-cheng-zhu-shi"></a>

1. 文件头部添加注释:快捷键：

   `window`：`ctrl+alt+i`

   mac：`ctrl+cmd+i`
2. 在光标处添加函数注释:快捷键：

   `window`：`ctrl+alt+t`

   `mac`：`ctrl+cmd+t(快捷键如果没有生效，注意快捷键是否被占用)`
