koro1FileHeader icon indicating copy to clipboard operation
koro1FileHeader copied to clipboard

替换掉param后会生成多余的空格

Open guohaomeng opened this issue 3 years ago • 2 comments

描述bug(必填)

替换掉param后会生成多余的空格

这应该是个bug吧🤣

注释设置(必填):

VsCode设置:

// 配置填在这里面
    // 头部注释
    "fileheader.customMade": {
        // 输出相对路径,类似: /文件夹名称/src/index.js
        "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
        // Author字段是文件的创建者 可以在specialOptions中更改特殊属性
        // 公司项目和个人项目可以配置不同的用户名与邮箱 搜索: gitconfig includeIf  比如: https://ayase.moe/2021/03/09/customized-git-config/
        // 自动提取当前git config中的: 用户名、邮箱
        "Author": "git config user.name", // 同时获取用户名与邮箱
        // "Author": "git config user.name", // 仅获取用户名
        // "Author": "git config user.email", // 仅获取邮箱
        // "Author": "OBKoro1", // 写死的固定值 不从git config中获取
        // 版本号
        "文件版本": "V1.0.0", // 文件版本号
        "Date": "Do not edit", // 文件创建时间(不变)
        // 插件会自动将光标移动到Description选项中 方便输入 Description字段可以在specialOptions更改
        "Description": "", // 介绍文件的作用、文件的入参、出参。
        // custom_string_obkoro1~custom_string_obkoro100都可以输出自定义信息
        // 可以设置多条自定义信息 设置个性签名、留下QQ、微信联系方式、输入空行等
        "custom_string_obkoro1": "",
        // LastEditors、LastEditTime、FilePath将会自动更新 如果觉得时间更新的太频繁可以使用throttleTime(默认为1分钟)配置更改更新时间。
        // "LastEditors": "git config user.name && git config user.email", // 文件最后编辑者 与Author字段一致
        // 由于编辑文件就会变更最后编辑时间,多人协作中合并的时候会导致merge
        // 可以将时间颗粒度改为周、或者月,这样冲突就减少很多。搜索变更时间格式: dateFormat
        // "LastEditTime": "Do not edit", // 文件最后编辑时间
        // 版权声明 保留文件所有权利 自动替换年份 获取git配置的用户名和邮箱
        // 版权声明获取git配置, 与Author字段一致: ${git_name} ${git_email} ${git_name_email}
        "custom_string_obkoro1_copyright": "版权信息         : ${now_year} by ${git_name}, All Rights Reserved."
        // "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 写死的公司名/用户名, All Rights Reserved. "
    },
    // 函数注释
    "fileheader.cursorMode": {
        "函数功能": "", // 函数注释生成之后,光标移动到这里
        "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
        "出口参数": "", // 返回值
        "函数备注": ""
    },
    // koroFileHeader插件配置
    "fileheader.configObj": {
        "createFileTime": true,
        "language": {
            // js后缀文件
            "js": {
                "head": "/$$",
                "middle": " $ @",
                "end": " $/",
                // 函数自定义注释符号:如果有此配置 会默认使用
                "functionSymbol": {
                    "head": "/******* ", // 统一增加几个*号
                    "middle": " * @",
                    "end": " */"
                },
                "functionParams": "typescript" // 函数注释使用ts语言的解析逻辑
            },
            // 一次匹配多种文件后缀文件 不用重复设置
            "h/c/hpp/cpp": {
                "head": "/*******************************************************************************", // 统一增加几个*号
                "middle": "****",
                "end": "********************************************************************************/"
            }
        },
        "autoAdd": true,
        "autoAddLine": 100,
        "autoAlready": true,
        "annotationStr": {
            "head": "/*",
            "middle": " * @",
            "end": " */",
            "use": false
        },
        "headInsertLine": {
            "php": 2,
            "sh": 2
        },
        "beforeAnnotation": {
            "文件后缀": "该文件后缀的头部注释之前添加某些内容"
        },
        "afterAnnotation": {
            "文件后缀": "该文件后缀的头部注释之后添加某些内容"
        },
        "specialOptions": {
            "Author": "作者名称",
            "FilePath": "文件路径",
            "Date": "创建日期",
            "Description": "简要说明",
            "param": "入口参数:", // [bug]替换后会出现多余的空格?
            "特殊字段": "自定义比如LastEditTime/LastEditors"
        },
        "switch": {
            "newlineAddAnnotation": true
        },
        "supportAutoLanguage": [],
        "prohibitAutoAdd": [
            "json"
        ],
        "folderBlacklist": [
            "node_modules",
            "文件夹禁止自动添加头部注释"
        ],
        "prohibitItemAutoAdd": [
            "项目的全称, 整个项目禁止自动添加头部注释, 可以使用快捷键添加"
        ],
        "moveCursor": true,
        "dateFormat": "YYYY-MM-DD HH:mm:ss",
        "atSymbol": [
            "@",
            "@"
        ],
        "atSymbolObj": {
            "文件后缀": [
                "头部注释@符号",
                "函数注释@符号"
            ]
        },
        "colon": [
            ": ",
            ": "
        ],
        "colonObj": {
            "文件后缀": [
                "头部注释冒号",
                "函数注释冒号"
            ]
        },
        "filePathColon": "路径分隔符替换",
        "showErrorMessage": true,
        "writeLog": false,
        "wideSame": true,
        "wideNum": 13,
        "functionWideNum": 0,
        "CheckFileChange": false,
        "createHeader": false,
        "useWorker": false,
        "designAddHead": false,
        "headDesignName": "random",
        "headDesign": false,
        "cursorModeInternalAll": {},
        "openFunctionParamsCheck": true,
        "functionParamsShape": [
            "{",
            "}"
        ],
        "functionBlankSpaceAll": {},
        "functionTypeSymbol": "*",
        "typeParamOrder": "param",
        "customHasHeadEnd": {},
        "throttleTime": 60000,
        "functionParamAddStr": ":",
        "NoMatchParams": "no show param"
    }

文件后缀(必填):

cpp

你得到的注释(必填):

你生成的注释为:

// 注释贴在这里面
/*******************************************************************************
****函数功能: 
****入口参数:         wave_type:
****出口参数: 
****函数备注: 
********************************************************************************/
void GenerateWave(int wave_type)

预期的行为(必填):

预期得到的注释/行为:

// 预期行为的注释贴在这里
/*******************************************************************************
****函数功能: 
****入口参数: wave_type:
****出口参数: 
****函数备注: 
********************************************************************************/
void GenerateWave(int wave_type)

guohaomeng avatar Jun 17 '22 12:06 guohaomeng

插件日志里也没有报错信息

guohaomeng avatar Jun 17 '22 12:06 guohaomeng

"wideNum": 13,

修改一下这个参数试试,个人之前出现类似问题是修改的这个参数解决的

DWin233 avatar Aug 16 '22 02:08 DWin233

更新插件,该问题已修复,觉得插件不错的话,点个Star吧~ ❤️

OBKoro1 avatar Jan 29 '23 08:01 OBKoro1