为实现该功能,需要添加 koroFileHeader插件。
添加插件后,再更改settings.json文件(在当前的settings.json底部添加koroFileHeader插件配置代码)。添加的内容如下
//文件头部注释
"fileheader.customMade": {
"custom_string_obkoro1": "Copyright (c) ${now_year} by THB",
"custom_string_obkoro2": "All Rights Reserved. ",
"custom_string_obkoro3": " ",
"custom_string_obkoro4": " ",
"Description": " ",
"Version": "0.0.1",
"Author": "R&d Division II",
"Date": "Do not edit",
"LastEditors": "R&d Division II",
"LastEditTime": "Do not edit",
},
// 函数注释
"fileheader.cursorMode": {
"brief": "", // 函数注释生成之后,光标移动到这里
"param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
"return": "",
},
// 插件配置项
"fileheader.configObj": {
"autoAdd": true, //"If this setting is false, no telemetry will be sent regardless of the new setting's value. Deprecated due to being combined into the `#telemetry.telemetryLevel#` setting.", // 检测文件没有头部注释,自动添加文件头部注释
"autoAddLine": 6, // 文件超过多少行数 不再自动添加头部注释
"autoAlready": true, // 只添加插件支持的语言以及用户通过`language`选项自定义的注释
"supportAutoLanguage": [
"c",
"cpp",
"hpp",
"h",
"cc"
], // 设置之后,在数组内的文件才支持自动添加
// 自动添加头部注释黑名单
"prohibitAutoAdd": [
"json",
"MD"
],
"prohibitItemAutoAdd": [
"项目的全称禁止项目自动添加头部注释, 使用快捷键自行添加"
],
"folderBlacklist": [
"node_modules"
], // 文件夹或文件名禁止自动添加头部注释
"wideSame": true, // 头部注释等宽设置
"wideNum": 14, // 头部注释字段长度 默认为13
"functionWideNum": 8, // 函数注释等宽设置 设为0 即为关闭
// 头部注释第几行插入
"headInsertLine": {
"php": 2 // php文件 插入到第二行
},
// 头部注释之前插入内容
"beforeAnnotation": {
// "文件后缀": "该文件后缀的头部注释之前添加某些内容"
"py": "#!/usr/bin/env python\n# coding=utf-8", // py文件默认,可修改
// "*": "\n" // 所有文件的头部注释都在前面增加一个换行(除了py)
},
// 头部注释之后插入内容
"afterAnnotation": {
"文件后缀": "该文件后缀的头部注释之后添加某些内容"
},
// 特殊字段自定义 比如: Author、LastEditTime、LastEditors、FilePath、Description、Date等
"specialOptions": {
"Date": "CreatDate"
},
"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": true, //每次保存之后,会进行一次diff检查, 如果文件只变更了LastEditors/LastEditTime,该文件将会回滚到本地仓库的最新版本.
"createHeader": true, // 新建文件自动添加头部注释
"useWorker": false, // 是否使用工作区设置
"designAddHead": false, // 添加注释图案时添加头部注释
"headDesignName": "random", // 图案注释使用哪个图案
"headDesign": false, // 是否使用图案注释替换头部注释
// 自定义配置是否在函数内生成注释 不同文件类型和语言类型
"cursorModeInternalAll": {
"ts": true, // ts文件后缀是函数内生成函数注释
"js": false, // js文件后缀是在函数外生成函数注释
"python": true, // python语言类型文件时在函数内生成函数注释
"defaultSetting": false // 默认是在函数外生成注释
}, // 默认为false 在函数外生成函数注释
"openFunctionParamsCheck": true, // 开启关闭自动提取添加函数参数
"functionParamsShape": [
"",
""
], // 函数参数外形自定义
//"functionParamsShape": "no type", //函数参数不需要类型
"functionBlankSpaceAll": {}, // 函数注释空格缩进 默认为空对象 默认值为0 不缩进
"functionTypeSymbol": "null", // 参数没有类型时的默认值
"typeParamOrder": "type param", // 参数类型 和 参数的位置自定义
"NoMatchParams": "no show param", // 没匹配到函数参数,是否显示@param与@return这两行 默认不显示param
"functionParamAddStr": ":", // 在 type param 后面增加字符串 可能是冒号,方便输入参数描述
// 自定义语言注释,自定义取消 head、end 部分
// 不设置自定义配置language无效 默认都有head、end
"customHasHeadEnd": {}, // "cancel head and function" | "cancel head" | "cancel function"
"throttleTime": 60000, // 对同一个文件 需要过1分钟再次修改文件并保存才会更新注释
// 自定义语言注释符号,覆盖插件的注释格式
"language": {
// js后缀文件
"js": {
"head": "/$$",
"middle": " $ @",
"end": " $/",
// 函数自定义注释符号:如果有此配置 会默认使用
"functionSymbol": {
"head": "/** ", // 统一增加几个*号
"middle": " * @",
"end": " **/"
},
"functionParams": "typescript" // 函数注释使用ts语言的解析逻辑
},
// 一次匹配多种文件后缀文件 不用重复设置
"h/hpp/cpp/c/cc": {
"head": "/**", // 统一增加几个*号
"middle": " * @",
"end": "**/"
},
// 针对有特殊要求的文件如:test.blade.php
"blade.php": {
"head": "<!--",
"middle": " * @",
"end": "-->",
}
},
// 默认注释 没有匹配到注释符号的时候使用。
"annotationStr": {
"head": "/**",
"middle": " * @",
"end": " **/",
"use": false
}
}