koro1FileHeader icon indicating copy to clipboard operation
koro1FileHeader copied to clipboard

有将@description默认更换成@brief吗

Open nightzijiang opened this issue 1 year ago • 2 comments

想要支持新的语言:

语言:C

目前插件生成的模板:


    // 函数注释
    "fileheader.cursorMode": {
        "description ": "", // 函数注释生成之后,光标移动到这里
        "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
        "return": "",
        "author": "RensLi", // 创建文件的作者
        "Date": "Do not edit", // 文件创建时间(不变)
    },

提供你最终想要的注释模板:

    // 函数注释
    "fileheader.cursorMode": {
        "brief":"",// 函数注释生成之后,光标移动到这里
        // "description ": "", // 函数注释生成之后,光标移动到这里
        "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
        "return": "",
        "author": "RensLi", // 创建文件的作者
        "Date": "Do not edit", // 文件创建时间(不变)
    },

您的特性请求是否与问题相关?请描述

现在不知是不是vscode更换了注释关键词,我在使用默认的模板时,生成的注释鼠标放在函数上面是不显示概要的 image image

描述一下你想要的解决方案. 如果换成这个样子就可以正确显示了,在其他的地方我只需要鼠标放在上面就可以正确显示注释,而无需跳转 image image

对你想要发生的事情的清晰而简明的描述。

描述你考虑过的备选方案 我曾经尝试过进行配置的修改,修改成

    // 函数注释
    "fileheader.cursorMode": {
        "brief":"",// 函数注释生成之后,光标移动到这里
        // "description ": "", // 函数注释生成之后,光标移动到这里
        "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
        "return": "",
        "author": "RensLi", // 创建文件的作者
        "Date": "Do not edit", // 文件创建时间(不变)
    },

这样,但是光标不会自动跳转,而且brief后面还有冒号。冒号紧贴brief就会造成不识别关键字,冒号分开就会造成成为后面注解文字的一部分。

nightzijiang avatar May 25 '23 05:05 nightzijiang

顶一下 我现在就是多打一个空格,让冒号分开看的很难受

sandstorm666 avatar Jul 18 '23 02:07 sandstorm666

我找到方法了你可以试一下在koro插件的setting.json中修改如下字段

"specialOptions": {
            "c":{
                "description" : "brief", // 替换函数注释中的description字段为brief
            },
            "h":{
                "description" : "brief", 
            },
            "cpp":{
                "description" : "brief", 
            },
            "hpp":{
                "description" : "brief", 
            },
        }, // 特殊字段自定义 比如: Author、LastEditTime、LastEditors、FilePath、Description、Date等
"colonObj": {
            "c": [": ", " "],  // 去除.c文件函数注释中的冒号      
            "h": [": ", " "], 
            "cpp": [": ", " "],           
            "hpp": [": ", " "],
        }, //  更改单独语言/文件的冒号

image image

wugeshenhuaking avatar Aug 31 '23 12:08 wugeshenhuaking