vsCode快速生成文件头注释和函数注释

推荐一个vsCode里超好用的插件(koroFileHeader),可快速生成注释模板(可自定义),就不用一个个敲/***/啦。

使用也很简单:

  1. 安装插件:
    vsCode快速生成文件头注释和函数注释_第1张图片
  2. 在设置中配置一下模板:
    vsCode快速生成文件头注释和函数注释_第2张图片
    vsCode快速生成文件头注释和函数注释_第3张图片
    然后就出现我们的setting.json文件
    加入以下设置:
"fileheader.configObj": { //快速添加文件头部注释和函数注释
        "createFileTime": true, // 设置为true则为文件新建时候作为date,否则注释生成时间为date
        "autoAdd": true, // 自动生成注释
        "annotationStr": {
            "head": "/*",
            "middle": " * @",
            "end": " */",
            "use": true // 设置自定义注释可用
        },
    },
    "fileheader.cursorMode": { // 快速注释函数 ctrl+alt+t
        "description": "", // 函数描述
        "param ": "", // 函数参数
        "return": "", // 函数输出
        "Author": "爱酱丶", // 作者
        "Date": "Do not edit", // 创建时间
        "LastEditTime": "Do not edit", // 最后一次修改的时间
        "LastEditors": "爱酱丶" // 修改人员
    },
    "fileheader.customMade": { // 快速注释文件头部 ctrl+alt+i
        "Description": "", // 文件描述
        "Author": "爱酱丶", // 作者
        "Date": "Do not edit", // 创建时间
        "LastEditTime": "Do not edit", // 最后一次修改的时间
        "LastEditors": "爱酱丶" // 修改人员
    }

vsCode快速生成文件头注释和函数注释_第4张图片

然后来试一下效果:
CTRL+alt+i
vsCode快速生成文件头注释和函数注释_第5张图片
CTRL+alt+t
vsCode快速生成文件头注释和函数注释_第6张图片
了解更多

【完】

你可能感兴趣的:(vsCode快速生成文件头注释和函数注释)