一、安装插件KoroFileHeader(函数标准注释)
在插件市场搜索KoroFileHeader,并安装,如下:
二、设置
安装完成后,点击vscode的设置面板,然后输入“fileheader”
-
文件头部注释:Fileheader:custom Made
-
函数注释:Fileheader:cursor Mode
随便点击哪个"在setting.json"中编辑,输入以下设置后保存,然后重启vscode更新设置:
// 文件头部注释
"fileheader.customMade": {
"Descripttion":"",
"version":"",
"Author":"sueRimn",
"Date":"Do not edit",
"LastEditors":"sueRimn",
"LastEditTime":"Do not Edit"
},
//函数注释
"fileheader.cursorMode": {
"name":"",
"test":"test font",
"msg":"",
"param":"",
"return":""
}
三、使用
- 文件头部注释
快捷键:crtl+alt+i(window),ctrl+cmd+t (mac)
生成样式如下:
/*
* @Author:
* @Date: 2020-06-01 11:58:32
* @LastEditors:
*/
- 函数注释
快捷键:ctrl+alt+t (window), ctrl+alt+t(mac)
生成样式如下:
/**
* @Descripttion:
* @Author:
* @Date: 2020-06-08 10:57:39
* @param {type}
* @return:
*/
四、使用无效
1 . 如果到第三个步骤的时候,可以正常使用,那么这一个步骤就不用看了。如果快捷键无效,可以优先考虑是快捷键产生了冲突,解决方案如下:
-
打开左上方 - 文件 - 首选项 - 键盘快捷键设置
-
找到重复的这个,把冲突的改为其他键
2 . 但是有的时候,搜索对应的快捷键是搜索不到的,如下:
我这里遇到的是ctrl+alt+t 产生问题,在github的issuse上可以看到这样的回复:
这个时候,直接搜索对应的fileheader、cursorTip名字,然后加上对应的快捷键即可。