jsdoc + koroFileHeader 代码注释规范和插件使用介绍

安装插件+配置

1、安装vscode插件 koroFileHeader

2、点击vscode左下角小齿轮=> settings=>搜索 fileheader=>Edit in settings.json

3、在文件中添加如下配置：

    "fileheader.customMade": { // 在文件头部插入注释 【快捷键 ctrl+alt+i】 【建议一个文件不超过300行，配置文件除外】

        "Description": "enter your description", // 文件描述描述，【必填】

        "Autor": "rjguan", // 作者，【自动填写】

        "Date": "Do not edit", // 创建时间 ，【自动填写】

        "LastEditors": "rjguan", // 最后更改人，【自动填写】

        "LastEditTime": "Do not edit" // 最后更改时间 ，【自动填写】

    },

    "fileheader.cursorMode": { // 在光标处插入注释【快捷键 ctrl+alt+t】

        "description": "enter your description", // 函数功能描述，【必填】

        "param": "", // 参数值，可不填，【建议，不要有过多的参数，建议不超过3个参数，如果超过，请使用字典方式组织参数】

        "return": "", // 返回值，可不填 optional

        "author": "rjguan", // 作者，【自动填写】

        "Date": "Do not edit", // 创建注释的时间，【自动填写】

    }

 

4、保存即可

 

 

使用方式：

在新建的文件中，ctrl+alt+i，自动生成头部注释，以后不需再次编辑，每次保存会自动刷新最后更改人和更改时间

在需要注释的函数中ctrl+alt+t，填写description

 

ps：1、 关键位置注释：占用一行，英文在前，中文在后

2、效果如下图