Vscode 函数注释插件koroFileHeader

在开发过程中,随手写注释是一个好习惯,若干年后重新看代码才能快速了解某函数的功能,提高代码可读性,以下是koroFileHeader在vscode的安装及使用,在此记录一下

一、搜索安装koroFileHeader

在这里插入图片描述

二、打开配置项

进入方式1:
在这里插入图片描述
进入方式2:
在这里插入图片描述

三、在setting搜索fileheader,打开配置项Cursor Mode

在这里插入图片描述

四、添加配置项

更多配置选项查看github
在这里插入图片描述

    "fileheader.cursorMode": { // 函数配置项
        "description": "", // 功能描述
        "param": "", // 传入参数
        "return": "", // 返回结果
    },

五、使用

写好函数之后,在函数名使用快捷键ctrl+win+t,生成函数说明模板并添加相关函数内容
在这里插入图片描述
如果不想生成头部注释,可以进行如下配置
在这里插入图片描述

六、效果

在调用该函数时,鼠标移到函数名,会显示相关函数说明
在这里插入图片描述

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值