自動生成注釋插件：koroFileHeader

1. 文件添加頭部注釋：

• 在當(dāng)前編輯文件中使用快捷鍵:window：ctrl+alt+i，mac：ctrl+cmd+i，linux：ctrl+meta+i 即可生成文件頭部注釋。

2. 在光標(biāo)處添加函數(shù)注釋

• 將光標(biāo)放在函數(shù)行或者將光標(biāo)放在函數(shù)上方的空白行
• 使用快捷鍵window：ctrl+alt+t，mac：ctrl+cmd+t，linux：ctrl+meta+t 即可生成函數(shù)注釋。

ctrl + shift + p 輸入settings.json打開配置文件

注釋模板配置https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE

    // 頭部注釋
    "fileheader.customMade": {
        // 頭部注釋默認(rèn)字段
        "Author": "user",
        "Date": "Do not edit", // 設(shè)置后默認(rèn)設(shè)置文件生成時間
        "LastEditTime": "Do not edit", // 設(shè)置后，保存文件更改默認(rèn)更新最后編輯時間
        "LastEditors": "user", // 設(shè)置后，保存文件更改默認(rèn)更新最后編輯人
        "Description": "",
        "FilePath": "Do not edit", // 設(shè)置后，默認(rèn)生成文件相對于項目的路徑
        "custom_string_obkoro1": "你也總是天亮了才睡!"
    },
    // 函數(shù)注釋
    "fileheader.cursorMode": {
        // 默認(rèn)字段
        "description": "",
        "param": "",
        "return": ""
    },
    // 插件配置項
    "fileheader.configObj": {
        "autoAdd": true, // 檢測文件沒有頭部注釋，自動添加文件頭部注釋
        "autoAddLine": 100, // 文件超過多少行數(shù) 不再自動添加頭部注釋
        "autoAlready": true, // 只添加插件支持的語言以及用戶通過`language`選項自定義的注釋
        // 自動添加頭部注釋黑名單
        "prohibitAutoAdd": [
            "json"
        ],
        "prohibitItemAutoAdd": [
            "項目的全稱禁止項目自動添加頭部注釋, 使用快捷鍵自行添加"
        ],
        "switch": {
            "newlineAddAnnotation": true // 默認(rèn)遇到換行符(\r\n \n \r)添加注釋符號
        },
        "wideSame": false, // 頭部注釋等寬設(shè)置
        "wideNum": 13, // 頭部注釋字段長度 默認(rèn)為13
        "moveCursor": true, // 自動移動光標(biāo)到Description所在行
        "dateFormat": "YYYY-MM-DD HH:mm:ss",
        "atSymbol": "@", // 更改所有文件的自定義注釋中的@符號
        "atSymbolObj": {}, //  更改單獨語言/文件的@
        "colon": ": ", // 更改所有文件的注釋冒號
        "colonObj": {}, //  更改單獨語言/文件的冒號
        "filePathColon": "路徑分隔符替換", // 默認(rèn)值： mac: / window是: \
        "showErrorMessage": false, // 是否顯示插件錯誤通知 用于debugger
        "CheckFileChange": false, // 單個文件保存時進(jìn)行diff檢查
        "createHeader": true, // 新建文件自動添加頭部注釋
        // 自定義語言注釋符號，覆蓋插件的注釋格式
        "language": {
            "java": {
                "head": "/$$",
                "middle": " $ @",
                "end": " $/"
            },
            // 一次匹配多種文件后綴文件 不用重復(fù)設(shè)置
            "h/hpp/cpp": {
                "head": "/*** ", // 統(tǒng)一增加幾個*號
                "middle": " * @",
                "end": " */"
            },
            // 針對有特殊要求的文件如：test.blade.php
            "blade.php": {
                "head": "<!--",
                "middle": " * @",
                "end": "-->",
            }
        },
        // 默認(rèn)注釋  沒有匹配到注釋符號的時候使用。
        "annotationStr": {
            "head": "/*",
            "middle": " * @",
            "end": " */",
            "use": false
        },
    }