VS Code笔记-----自动生成文件头部注释和函数注释（KoroFileHeader）

1、安装插件KoroFileHeader

在vscode商店中搜索KoroFileHeader并安装

2、设置

在vscode左下角点击设置按钮，选择“设置”，然后输入“fileheader”,或点击vscode商店中已安装项目上KoroFileHeader设置按钮选择扩展设置

• 文件头部注释：Fileheader:custom Made
• 函数注释：Fileheader:cursor Mode
• 插件配置：fileheader.configObj

随便点击哪个"在setting.json"中编辑，输入以下设置后保存，然后重启vscode更新设置：

    //配置新建文件注释和方法注释
    "fileheader.configObj": {
        "createFileTime": true, //设置为true则为文件新建时候作为date，否则注释生成时间为date
        "autoAdd": true, //自动生成注释，老是忘记的同学可以设置
        "annotationStr": {
            "head": "/*",
            "middle": " * @",
            "end": " */",
            "use": true //设置自定义注释可用
        },
        "headInsertLine": {
            "php": 2
        }
    },
    "fileheader.cursorMode": {
        "description": "",
        "param ": "",
        "return": ""
    },
    "fileheader.customMade": {
        "Description": "", //文件内容描述
        "Author": "maple", //编辑人
        "Date": "Do not edit", //时间
        "LastEditTime": "Do not edit",
        "LastEditors": "maple",
    }

3、生成注释快捷键

1. 文件头部添加注释:快捷键：window：ctrl+alt+I,mac：ctrl+cmd+I

2. 在光标处添加函数注释:快捷键：window：ctrl+alt+T,mac：ctrl+cmd+T(快捷键如果没有生效，注意检查快捷键是否被占用)