【VSCode】插件

一、koro1FileHeader或Document this

1. 文件头部添加注释:

• 在文件开头添加注释，记录文件信息 / 文件的传参 / 出参等
• 支持用户高度自定义注释选项，适配各种需求和注释。
• 保存文件的时候，自动更新最后的编辑时间和编辑人
• 快捷键：window：ctrl+alt+i,mac：ctrl+cmd+i, linux: ctrl+meta+i

2. 在光标处添加函数注释:

• 在光标处自动生成一个注释模板
• 支持用户高度自定义注释选项
• 快捷键：window：ctrl+alt+t,mac：ctrl+cmd+t,linux: ctrl+meta+t
• 快捷键不可用很可能是被占用了，参考这里

setting中搜索fileheader，编辑json文件。
.vscode 目录中的 settings.json 内容：

{
    // 头部注释
    "fileheader.customMade": {
        // 头部注释默认字段
	    "Author":"[you name]",
	    "Date": "Do not edit", // 文件创建时间(不变)
	    "LastEditors": "[you name]", // 文件最后编辑者
	    "LastEditTime": "Do not edit", // 文件最后编辑时间
	    "Description":""
    },
    // 函数注释
    "fileheader.cursorMode": {
	    "Author":"[you name]",
	    "description": "", 
	    "param": "", 
	    "return":""
    },
    // 插件配置项
    "fileheader.configObj": {
        "autoAdd": true, // 检测文件没有头部注释，自动添加文件头部注释
        "autoAlready": true, // 只添加插件支持的语言以及用户通过`language`选项自定义的注释
                // 自动添加头部注释黑名单
        "prohibitAutoAdd": [
            "json",
            "md"
        ],
        // 前面的比较重要
        
        "supportAutoLanguage": [], // 设置之后，在数组内的文件才支持自动添加
        "autoAddLine": 100, // 文件超过多少行数 不再自动添加头部注释
        "prohibitItemAutoAdd": [
            "项目的全称禁止项目自动添加头部注释, 使用快捷键自行添加"
        ],
        "folderBlacklist": [
            "node_modules"
        ], // 文件夹或文件名禁止自动添加头部注释
        "wideSame": false, // 头部注释等宽设置
        "wideNum": 13, // 头部注释字段长度 默认为13
        "functionWideNum": 1, // 函数注释等宽设置 设为0 即为关闭
        // 头部注释第几行插入
        "headInsertLine": {
            "python": 2 // php文件 插入到第二行
        },
        "beforeAnnotation": {}, // 头部注释之前插入内容
        "afterAnnotation": {}, // 头部注释之后插入内容
        "specialOptions": {}, // 特殊字段自定义
        "switch": {
            "newlineAddAnnotation": true // 默认遇到换行符(\r\n \n \r)添加注释符号
        },
        "moveCursor": true, // 自动移动光标到Description所在行
        "dateFormat": "YYYY-MM-DD HH:mm:ss",
        "atSymbol": [
            ":",
            ":"
        ], // 更改所有文件的自定义注释中的@符号
        "atSymbolObj": {}, //  更改单独语言/文件的@
        "colon": [
            ": ",
            ": "
        ], // 更改所有文件的注释冒号
        "colonObj": {}, //  更改单独语言/文件的冒号
        "filePathColon": "路径分隔符替换", // 默认值： mac: / window是: \
        "showErrorMessage": false, // 是否显示插件错误通知 用于debugger
        "writeLog": false, // 错误日志生成
        "CheckFileChange": false, // 单个文件保存时进行diff检查
        "createHeader": true, // 新建文件自动添加头部注释
        "useWorker": false, // 是否使用工作区设置
        "designAddHead": false, // 添加注释图案时添加头部注释
        "headDesignName": "random", // 图案注释使用哪个图案 
        "headDesign": false, // 是否使用图案注释替换头部注释
        "cursorModeInternal": false, // 是否在函数内生成函数注释
        "cursorModeInternalAll": {
            "python": true
        }, // 自定义配置是否在函数内生成注释 不同文件类型和语言类型 
        "openFunctionParamsCheck": true, // 开启关闭自动提取添加函数参数
        "functionParamsShape": [
            "(",
            ")"
        ], // 函数参数外形自定义
        "functionBlankSpace": 4, // 函数注释空格缩进
        "functionTypeSymbol": "object", // 参数没有类型时的默认值
        "typeParamOrder": "param type", // 参数类型 和 参数的位置自定义
        // 自定义语言注释符号，覆盖插件的注释格式
        "language": {
            // js后缀文件
            "python": {
                "head": "# -*- coding:utf-8 -*-\n\"\"\"",
                "middle": ":",
                "end": "\"\"\"",
                // 函数自定义注释符号：如果有此配置 会默认使用
                "functionSymbol": {
                    "head": "\"\"\"", // 统一增加几个*号
                    "middle": ":",
                    "end": "\"\"\"",
                }
            }
        },
        // 默认注释  没有匹配到注释符号的时候使用。
        "annotationStr": {
            "head": "\"\"\"",
            "middle": "",
            "end": "\"\"\"",
            "use": false
        },
    }
}

如果不起效，可能是快捷键被占用，Ctrl+Shift+p中搜索cursorTip，看目前函数注释的快捷键是什么。

https://juejin.cn/post/6844903694165606408
https://juejin.cn/post/6995464881205936164