vscode文件頭部註釋插件koroFileHeader配置

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.customMade": {
        "Description": "",
        "LastEditors": "OBKoro1",
        "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
 -->