koroFileHeader用法总结--手把手教程
插件特点:
自动生成文件头部注释,自动更新最后编辑人、最后编辑时间等。
一键生成函数注释,支持函数参数自动提取并列到注释中。
配置非常灵活方便,各种细节都能配置,可以量身打造适合你的注释。
支持所有主流语言, 配置文档非常详细,齐全。
支持自动提取git信息
step1:修改配置文件
在V S code中 利用搜索ctrl+P 打开搜索框,输入setting 打开如下图的配置文件;(注意修改根目录用户下的配置文件 .config>Code>User>Settings.json)
Ubuntu电脑:运行下列命令可以直接打开配置进行修改,将配置文件复制到settings.json中注意逗号是否缺少,导致报错。
abc@tower:~$ code .config/Code/User/settings.json
将下列配置文件拷贝到上述打开的setting.json文件中。
step2:安装 VScode插件:koroFileHeader
插件搜索koroFileHeader-->安装插件
Step3:快捷键修改
如果快捷键有冲突,自己替换快捷键即可。
step4:重启VScode
Step5:想要个性化配置
以后如何想要修改配置文件,可通过以下方式访问配置文件
files-->Preferences-->Setting-->User-->Extensions-->file header Configuration-->Edit in settings.json 然后字形设置配置即可。
使用方法:
函数注释注释快捷键
更多关于函数参数自动请查阅文档
-
将光标放在函数行或者将光标放在函数上方的空白行。 自动解析函数参数,生成函数参数注释。 快捷键:window:ctrl+win+t,mac:ctrl+cmd+t,linux: ctrl+meta+t, Ubuntu: ctrl+super+t 上述我们设置的快捷键:文件注释 ctrl+Alt+H,函数注释Ctrl+Alt+F
效果
其他总结
官方教程
多行函数参数鼠标选中后函数声明后按快捷键自动提取
- 鼠标左键选择多行函数声明区域,函数声明区域尽量精准
- 按函数注释快捷键
函数注释光标移动到下一行,快速添加函数参数描述
window: win+y, mac: cmd+y, linux: meta+y
生成函数注释之后,使用快捷键移动鼠标到下一行,快速为函数参数添加描述。
可能有很多参数,需要移动鼠标一个一个添加的话,操作起来有点麻烦。
正在上传…重新上传取消正在上传…重新上传取消
快捷键不可用的问题
快捷键不可用很可能是被占用了,
上一篇:
Python 安装包管理工具 pip
下一篇:
develop 工具建立枚举参数变量