VsCode如何生成文件头部注释和函数注释

有时候项目多人协作开发,使用插件记录一下,方便后期维护

一、设置过程

1、安装插件KoroFileHeader

2、左下角选择管理---设置---输入"fileheader"---点击"在setting.json中编辑"

3、把下面的代码放到json文件最外层{}中

// 文件头部注释
    "fileheader.customMade": {
        "Descripttion":"",
        "version":"xxx",
        "Author":"caseywei",
        "Date":"Do not edit", // 不需要设置,按下快捷键后自动生成
        "LastEditors":"caseywei",
        "LastEditTime":"Do not Edit"// 不需要设置,按下快捷键后自动生成
    },
    //函数注释
    "fileheader.cursorMode": {
        "name":"",
        "test":"test font",
        "msg":"",
        "param":"",
        "return":""
    }


二、设置之后的结果

快捷键:ctrl + alt + i 生成头部注释

/*
 * @Descripttion:有关xxx的xxx
 * @version: xxx
 * @Author: ***
 * @Date: 2019-11-08 11:59:43
 * @LastEditors: ***
 * @LastEditTime: 2019-11-08 11:59:46
 */
快捷键:ctrl + alt + t 生成函数注释

/**
 * @name: 
 * @test: test font
 * @msg: 
 * @param {type} 
 * @return: 
 */
发布了452 篇原创文章 · 获赞 83 · 访问量 27万+

猜你喜欢

转载自blog.csdn.net/caseywei/article/details/102971748