vscode注释插件

VSCODE注释插件：koro1FileHeader

按koroFileHeader 插件,配置默认注释

1.在扩展中搜索koroFileHeader，安装

2.安装完成后，在设置中搜索，koro1FileHeader,

3.配置文案

// 文件头部注释
     "fileheader.customMade": {
        "version": "V1.0.0", //版本号
        "Author": "lilun", //作者
        "Date": "Do not edit", //文件创建创建时间
        "LastEditors": "lilun", //最后编辑作者
        "LastEditTime": "Do not Edit", //最后编辑时间
        "company": "轩田科技", //公司名称
        "Mailbox": "lilun@sharetek.com.cn",//邮箱
        "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
        "Descripttion": "", //文本描述
    }, //函数注释
    "fileheader.cursorMode": {
        "description": "", //方法描述
        "param ": "", //参数
        "return": ""
    },

3.1自动添加文件头部注释

`"fileheader.configObj": {`
  `"autoAdd": true, // 自动添加头部注释开启才能自动添加`
  `"autoAlready": true, // 默认开启`
`}`

3.2 设定某些后缀文件不加头部注释

"fileheader.configObj": {
    "prohibitAutoAdd": [ "json", "md" ] // 禁止.json .md文件，自动添加头部注释
}

3.3 配置语言支持

什么意思呢？就是除了插件默认支持的语言我们还想增加其他语言配置怎么办呢？

下面我来演示支持C#的动作

注意：按文件后缀名配置

默认支持语言：Java 、JavaScript、Python、Php、TypeScript等

Angular、React 、Vue3.0均是 TypeScript Vue1.0与2.0是JavaScript

"language": {
            "languagetest": {
                "head": "/$$",
                "middle": " $ @",
                "end": " $/",
                "functionSymbol": {
                    "head": "/** ",
                    "middle": " * @",
                    "end": " */"
                },
                "functionParams": "js"
            },
            //按文件后缀来配置
            "cs": {
                "head": "/***",
                "middle": " * @",
                "end": " */",
                // 函数自定义注释符号：如果有此配置 会默认使用
                "functionSymbol": {
                    "head": "/******* ", // 统一增加几个*号
                    "middle": " * @",
                    "end": " */"
                }
            },
        },

4.配置完毕使用快捷键生成

• 文件头部注释快捷键：ctrl + win + i

• 函数注释注释快捷键: ctrl + win + t