脚本宝典收集整理的这篇文章主要介绍了koroFileHeader 非常实用的Vscode 插件[用于添加文件头部注释],脚本宝典觉得挺不错的,现在分享给大家,也给大家做个参考。
koroFileHeader
一个读取用户自定义模板,通过快捷键添加文件头部注释、在光标处添加函数注释的VsCode
插件
language
一些文档
简介
-
文件头部添加注释:
在光标处添加函数注释:
- 在光标处自动生成一个注释模板,下方有栗子
- 支持用户高度自定义注释选项
- 快捷键:
window
:ctrl+alt+t
,mac
:ctrl+cmd+t
- 快捷键不可用很可能是被占用了,参考这里
- 支持不同语言的注释格式,如下。
支持注释格式:
安装
在 Vscode 扩展商店中搜索koroFileHeader
,点击安装即可。
使用
- 文件头部注释:
在当前编辑文件中使用快捷键:window
:ctrl+alt+t
/mac
:ctrl+cmd+t
,即可生成文件头部注释。
-
函数注释:
- 将光标放在函数行或者将光标放在函数上方的空白行
- 使用快捷键
window
:ctrl+alt+t
,mac
:ctrl+cmd+t
,即可生成函数注释。
- 事实上,函数注释在文件的任意位置都可生成,这里需要自己控制。
注释模板的设置
-
默认配置:
在用户首选项中搜索fileheader
,默认配置为:
"fileheader.customMade": {} // 头部注释
"fileheader.cursorMode": {} // 函数注释
用户未设置的情况下,头部注释和函数注释模板为:
*/
// 函数注释
/**
* @name:
* @test: test font
* @msg:
* @param {tyPE}
* @return:
*/
自动更新最后编辑时间、编辑人:
要开启这个功能,需要在首选项设置中填写对应的属性:
"fileheader.customMade": {
"Date": "Do not edit", // 文件创建时间(不变)
"LastEditors": "OBKoro1", // 文件最后编辑者
"LastEditTime": "Do not edit" // 文件最后编辑时间
}
// 不填写对应属性即关闭对应功能
自动更新编辑时间
示例:
最后
以上是脚本宝典为你收集整理的koroFileHeader 非常实用的Vscode 插件[用于添加文件头部注释]全部内容,希望文章能够帮你解决koroFileHeader 非常实用的Vscode 插件[用于添加文件头部注释]所遇到的问题。
本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。