作为一个有思想有个性的程序员写的代码一定是要有风格的,比如什么佛祖保佑永无Bug、神兽护体等形式的注释,既有趣又个性。
给大家介绍一个非常有中国风的注释插件koroFileHeader,我们先来了解一下这个插件
koroFileHeader插件简介
这个插件目前有1300+Star,全五星好评,8万次下载,所以是个非常不错的插件。
插件的作用是生成文件头部注释和函数注释。
一键添加佛祖保佑注释
在VSCode的插件市场中,搜索koroFileHeader并进行安装,安装完成后可以新建一个test.js文件,
如果你是windows电脑,使用ctrl+shift+p键,Mac电脑使用shift+command+p键,然后输入/codeDesign,就可以选择注释图案了
插件里边的图案有佛祖、佛曰、美女、龙图腾......等等,你可以下载下来自己测试一下。
正常头部文件注释
其实这个"骚注释"只是插件的功能之一,更多的应用是自动根据我们的需求快速生成注释,比如在test.js中点击快捷键ctrl+alt+i(Windows),如果你是Mac电脑点击ctrl+cmd+i.就会快速生成这样的代码注释(我这里以JS代码注释为例,但这个插件可以支持所有主流语言,支持自定义语言).
/*
* @Author: your name
* @Date: 2020-06-07 17:35:49
* @LastEditTime: 2020-06-07 17:37:04
* @LastEditors: Please set LastEditors
* @Description: In User Settings Edit
* @FilePath: \vue-element-admin-master\src\wangrong.js
*/
这时候你会发现这里的Author是需要配置的,其实配置这个也非常的容易,我们简单配置一下。在VSCode菜单栏点击File-Preferences-Settings-Extensions里找到File header Configuration,在文件头部模块中(Fileheader)点击Edit in settings.json,修改配置文件如下:
{
"fileheader.configObj": {
},
"fileheader.customMade": {
"Author": "wangrong",
"Date": "Do not edit", // 文件创建时间(不变)
"LastEditors": "技术胖", // 文件最后编辑者
"LastEditTime": "Do not edit", // 文件最后编辑时间
"FilePath": "Do not edit" ,// 增加此项配置即可
}
}
修改完成后,要保存,然后退出VSCode,再进来,进入test.js,输入ctrl+alt+i这时候就变成了下面的样子。
/*
* @Author: wangrong
* @Date: 2020-05-21 10:29:21
* @LastEditors: 技术胖
* @LastEditTime: 2020-05-21 11:28:16
* @FilePath: \MarkDown_blog\test.js
*/