VSCode编辑器-koroFileHeader插件

在团队中进行开发时，统一注释格式很重要。以下是记录如何在VScode中使用koroFileHeader来统一注释格式，效果如下图：

安装

在插件中查询插件koroFileHeader，安装

配置

打开设置-搜索：fileheader 点击：settings.json 如下图：

我只配置了这一个文件，其它的自己百度吧！

代码

{
    "git.ignoreWindowsGit27Warning": true,
    "fileheader.customMade": {
        
        //此为头部注释
        "Autor":"chenqinglong", // 文件创建人
        "Date": "Do not edit", // 文件创建时间(不变)
        "LastEditors": "chenqinglong", // 文件最后编辑者
        "LastEditTime": "Do not edit", // 文件最后编辑时间
        "Introduce": "", // 介绍
        "FilePath": "" // 文件路径
    },
    "fileheader.cursorMode": {  //此为函数注释
        "description":"",
        "param": "",
        "return": "",
        "author":"chenqinglong"
    },
    "editor.minimap.enabled": false
}

保存重启就可以了！

注意点

团队使用时，需要所有人都在vscode上配置一样的格式，自己的名字，这样才会有效使用。

配方妙处

1、从注释上可以看出是谁创建，谁修改
2、从注释上可以看出最后修改时间（保存时会自动更新）