Vscode自动生成注释的神器-KoroFileHeader

发布时间 2023-06-28 14:34:07作者: 牛man

1、安装KoroFileHeader
设置 -->扩展(ctrl +S)--> 搜索KoroFileHeader ,并安装

 

2、设置函数注释与文档注释
设置 —》 搜索 file header configuration -》编辑setting.json 文件设置自己的注释格式

 

 

   //文件头注释
    "fileheader.customMade": {
        "File name":"",
        "Author":"Gu Chunqi(guchunqi@cvte.com)",
        "Version":"V1.0",
        "Date":"",
        "Description":"",
        "custom_string_obkoro1_copyright": "Copyright (C) 2020-{year} Tsing Micro Technology Inc All rights reserved.",
    }
    ,
    // 插件配置
    "fileheader.configObj": {

        "createFileTime": true,
        "autoAdd":false,  //关闭自动生成头部注释,使用快捷键手动添加
        "language": {
            "h/c/hpp/cpp": {
                "head": "/**",
                "middle": "* @",
                "end": "*/",
            },
        },

    } , 
      //函数注释
      "fileheader.cursorMode": {
        
        "brief":  "",
        "param":  "",
        "return": "",
        "note":   "none",

      }

 

3、查看函数注释的快捷键(插件默认的快捷键:头注释ctrl+win+i,函数注释:ctrl+alt+t)
打开键盘快捷键 -----》 输入extension.cursor ,查找结果就是函数注释的命令,也可看到快捷键,冲突的话,自行修快捷键即可

 

 

这里可以看到我的快捷键是 \

4、定位光标到函数前一行,按下快捷键生成函数注释,