1、安装koroFileHeader
直接去搜索点击安装就可以了。
2、配置
如果不修改默认的配置头部注释效果如下,我想去掉Author和LastEditors,并调整顺序,配置完记得重启vscode
/***
* Author : ''
* Date : 2019-05-13 15:54:32
* LastEditors : ''
* LastEditTime : 2020-02-14 22:04:52
* FilePath : /fileHead/index.html
* Description : 首页
**/
下面我贴出了json文件的全部内容,你只需要把fileheader.customMade
和fileheader.cursorMode
放进去就可以了。
- fileheader.customMade 是头部文件注释的配置
- fileheader.cursorMode 是函数注释的配置
- prohibitAutoAdd设置md和json文件不自动添加头部注释
- 如果你要了解更多的配置可以看koroFileHeader的官方文档
- 要了解更多的编码规范可以参考javascript编码规范
{
"editor.fontSize": 20,
"files.autoSave": "onFocusChange",
"editor.formatOnPaste": true,
"editor.formatOnSave": true,
"[vue]": {
"editor.defaultFormatter": "octref.vetur"
},
"workbench.colorTheme": "Solarized Light",
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"fileheader.customMade": {
"Description": "",
"Date": "Do not edit",
"LastEditTime": "Do not edit",
"FilePath": "Do not edit"
},
"fileheader.cursorMode": {
"description": "",
"event": "",
"param": "",
"return": ""
},
"fileheader.configObj": {
"prohibitAutoAdd": [
"json",
"md"
]
}
}
3、如何使用
文件头部添加注释:
- 快捷键:ctrl+alt+i
- 功能:保存文件的时候,自动更新最后的编辑时间和编辑人
在光标处添加函数注释:
- 快捷键:ctrl+alt+t
- 功能在光标处自动生成一个注释模板
效果
<!--
* @Description: 订单列表头部
* @Date: 2019-09-02 09:59:06
* @LastEditTime: 2020-03-09 13:56:08
* @FilePath: \6666\src\views\rent\order\order1\module\header.vue
-->