在开发过程中,随手写注释是一个好习惯,若干年后重新看代码才能快速了解某函数的功能,提高代码可读性,以下是koroFileHeader
在vscode的安装及使用,在此记录一下
一、搜索安装koroFileHeader
二、打开配置项
进入方式1:
进入方式2:
三、在setting搜索fileheader,打开配置项Cursor Mode
四、添加配置项
更多配置选项查看github
"fileheader.cursorMode": { // 函数配置项
"description": "", // 功能描述
"param": "", // 传入参数
"return": "", // 返回结果
},
五、使用
写好函数之后,在函数名使用快捷键ctrl+win+t
,生成函数说明模板并添加相关函数内容
如果不想生成头部注释,可以进行如下配置
六、效果
在调用该函数时,鼠标移到函数名,会显示相关函数说明