koroFileHeader

2021-12-24

字数统计: 1.4k字 | 阅读时长: 5分

在vscode中用于生成文件头部注释和函数注释的插件，经过多版迭代后，插件：支持所有主流语言,灵活方便，文档齐全，食用简单！

插件主要功能

自动生成文件头部注释，自动更新最后编辑人、最后编辑时间等。
一键生成函数注释，支持函数参数自动提取并列到注释中。
经过几年维护，支持所有主流语言, 文档齐全，使用简单，配置灵活方便，
支持添加佛祖保佑永无bug、神兽护体、甩葱少女等好玩有趣的图像注释

简介

文件头部添加注释:

在文件开头添加注释，记录文件信息/文件的传参/出参等

支持用户高度自定义注释选项, 适配各种需求和注释。

保存文件的时候，自动更新最后的编辑时间和编辑人

快捷键：window：ctrl+alt+i,mac：ctrl+cmd+i, linux: ctrl+meta+i,Ubuntu: ctrl+super+i

在光标处添加函数注释:

在光标处自动生成一个注释模板, 自动解析函数参数，生成函数参数注释。

支持用户高度自定义注释选项

快捷键：window：ctrl+alt+t,mac：ctrl+cmd+t,linux: ctrl+meta+t, Ubuntu: ctrl+super+t

快捷键不可用很可能是被占用了,参考[KoroFileHeader快捷键失效]的解决办法

支持一键添加佛祖保佑永无BUG、神兽护体等注释图案

korofileheader设置

{
    "fileheader.configObj": {
        "folderBlacklist": [
            "node_modules",
            "文件夹或文件名禁止自动添加头部注释",
            // "webpack.config.js" // 可以禁止某些文件自动添加注释
        ],
        "createHeader": true, // 新建文件自动添加头部注释 默认打开
        "autoAdd": true, // 默认开启
        "autoAlready": true, // 默认开启
        "headDesignName": "belle", //美女
        "designAddHead": true, // 命令行生成图案注释 默认关闭该功能
        "autoAddLine": 80, // 默认文件超过80行就不再自动添加头部注释
        "filePathColon": "\\\\", // \ 路径要转义 所以要写两遍
        "wideSame": true, // 设置为true开启
        "wideNum": 13, // 字段长度 默认为13
        "functionWideNum": 13, // 0 默认关闭 设置一个正整数即可开启 比如12
        "openFunctionParamsCheck": true, // 函数注释自动提取函数的参数 默认开启
        "functionParamsShape": [
            "{",
            "}"
        ], // 函数参数外形自定义
        "functionTypeSymbol": "*", // 参数没有类型时的默认值
        "typeParamOrder": "type param", // 参数类型 和 参数的位置自定义
        "throttleTime": 60000, // 对同一个文件 需要过1分钟再次修改文件并保存才会更新注释
        "cursorModeInternalAll": { // 函数内生成函数注释
            "ts": true, // ts文件后缀是函数内生成函数注释
            "js": false, // js文件后缀是在函数外生成函数注释
            "python": true, // python语言类型文件时在函数内生成函数注释
            "defaultSetting": false // 默认是在函数外生成注释
        },
        "functionBlankSpaceAll": { // 函数注释空格缩进
            // "js": 2, // 单独设置文件：js文件后缀 缩进两格
            "python": 0, // 设置语言：python语言类型 函数注释空格缩进4格
            "defaultSetting": 0 // 不设置 默认值为0
        },
        "headInsertLine": {
            "php": 2, // php后缀的文件，在第二行插入文件头部注释
            "*": 0, // 所有文件都在第0行插入注释(除了php)
        },
        "beforeAnnotation": {
            "py": "#!/usr/bin/env python\n# coding=utf-8", // py文件默认，可修改
            "*": "\n" // 所有文件的头部注释都在前面增加一个换行(除了py)
        },
        "afterAnnotation": {
            "*": "\n" // 所有文件新增头部注释之后都空一行(除了js)
        }, // 需要特殊定制的文件后缀
        "prohibitAutoAdd": [
            "json",
            "md"
        ], // 禁止.json .md文件，自动添加头部注释
        "supportAutoLanguage": [
            "py",
            "js"
        ], // 设置过后只有该数组里面的文件 才会自动添加头部注释
        "language": {
            "py": {
                "head": "\"\"\"", // 自定义注释头部
                "middle": "# ", // 自定义注释中间部分(注意空格,这也是最终生成注释的一部分)
                "end": "\"\"\"", // 自定义注释尾部
            },
            // 普通后缀文件
            "js": {
                "head": "//",
                "middle": "//",
                "end": " //",
                // 函数自定义注释符号：如果有此配置 会默认使用
                "functionSymbol": {
                    "head": "/******* ", // 统一增加几个*号
                    "middle": " * @",
                    "end": " */"
                }
            },
            // 一次匹配多种文件后缀文件 不用重复设置
            "h/hpp/cpp": {
                "head": "/*** ", // 统一增加几个*号
                "middle": " * @",
                "end": " */"
            },
        }
    },
    "fileheader.customMade": {
        "Date": "Do not edit", // 文件创建时间(不变)
        "LastEditor": "kangzai228", // 文件最后编辑者
        "Author": "kangzai228", //文件的作者
        "LastEditTime": "Do not edit", // 文件最后编辑时间
        "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
        "Description": "",
    }, // 头部注释
    "fileheader.cursorMode": {
        "description": "",
        "param": "",
        "return": "",
    }, // 函数注释 
}

问题

vscode1.63.2 system setup,python3代码中函数注释自动提取函数的参数无效