这篇文章主要讲解了“VSCode多行注释插件KoroFileHeader如何使用”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“VSCode多行注释插件KoroFileHeader如何使用”吧！
VSCode插件: 用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。
插件可以帮助用户养成良好的编码习惯，规范整个团队风格。
自动生成文件头部注释，自动更新最后编辑人、最后编辑时间等。
一键生成函数注释，支持函数参数自动提取并列到注释中。
支持添加佛祖保佑永无bug、神兽护体、甩葱少女等好玩有趣的图像注释。
配置非常灵活方便，各种细节都能配置，可以量身打造适合你的注释。
支持所有主流语言, 配置文档非常详细，齐全。
在 Vscode 扩展商店中搜索koroFileHeader, 点击安装。
window：ctrl+win+i,mac：ctrl+cmd+i, linux: ctrl+meta+i,Ubuntu: ctrl+super+i
window：ctrl+win+t,mac：ctrl+cmd+t,linux: ctrl+meta+t, Ubuntu: ctrl+super+t
函数注释光标移动到下一行行尾，快速添加函数参数描述
window: win+y, mac: cmd+y, linux: meta+y
随机生成：window：ctrl+alt+j, mac：ctrl+cmd+j
精确选择：快捷键Ctrl + P,输入> codeDesign,选择想要的图案注释
经常出现快捷键失灵的情况，这是由于VSCode快捷键冲突导致。这时需要我们自定义VSCode快捷键。
点击VSCode左下角管理图标-->点击键盘快捷方式，或直接使用快捷键Ctrl + K Ctrl + S打开键盘快捷方式修改窗口。
注意：修改快捷键前先查看想要使用的快捷键是否被占用。
一共四个快捷键需要设置，分别搜索
头部注释：extension.fileheader
函数注释：extension.cursorTip
光标移动：koroFileheader.table
随机图案：extension.codeDesign
"fileheader.customMade": {
//此为头部注释
"Description": "",
"Version": "V1.0.0",
"Author":"git config user.name && git config user.email",
"Date": "Do not edit",
"LastEditors": "git config user.name && git config user.email",
"LastEditTime": "Do not edit",
"FilePath": "only file name",
// 版权声明 保留所有权利 自动替换年份
"custom_string_obkoro1_copyright": "Copyright ${now_year} Marvin, All Rights Reserved. ",
"custom_string_obkoro1_date": "Do not edit", // 版权时间
},
"fileheader.cursorMode": {
//此为函数注释
"description": "",
"param": "",
"return": "",
"Date": "Do not edit",
"Author": "git config user.name && git config user.email",
"LastEditors": "git config user.name && git config user.email",
"LastEditTime": "Do not edit"
},
"fileheader.configObj": {
"createFileTime": false,
"language": {
"languagetest": {
"head": "/$$",
"middle": " $ @",
"end": " $/",
"functionSymbol": {
"head": "/** ",
"middle": " * @",
"end": " */"
},
"functionParams": "js"
}
},
"autoAdd": false, // 自动添加头部注释是否开启，默认为true
"autoAddLine": 100,
"autoAlready": true,
"annotationStr": {
"head": "/*",
"middle": " * @",
"end": " */",
"use": false
},
"headInsertLine": {
"php": 2,
"sh": 2
},
"beforeAnnotation": {
"文件后缀": "该文件后缀的头部注释之前添加某些内容"
},
"afterAnnotation": {
"文件后缀": "该文件后缀的头部注释之后添加某些内容"
},
"specialOptions": {
"特殊字段": "自定义比如LastEditTime/LastEditors"
},
"switch": {
"newlineAddAnnotation": true
},
"supportAutoLanguage": [],
"prohibitAutoAdd": ["json", "md"], // 禁止自动添加头部注释的文件类型
"folderBlacklist": ["node_modules", "文件夹禁止自动添加头部注释"],
"prohibitItemAutoAdd": ["项目的全称, 整个项目禁止自动添加头部注释, 可以使用快捷键添加"],
"moveCursor": true,
"dateFormat": "YYYY-MM-DD HH:mm:ss",
"atSymbol": ["@", "@"],
"atSymbolObj": {
"文件后缀": ["头部注释@符号", "函数注释@符号"]
},
"colon": [": ", ": "],
"colonObj": {
"文件后缀": ["头部注释冒号", "函数注释冒号"]
},
"filePathColon": "路径分隔符替换",
"showErrorMessage": false,
"writeLog": false,
"wideSame": true,
"wideNum": 13, // 头部注释自动对齐的宽度
"functionWideNum": 15, // 函数注释自动对齐宽度
"CheckFileChange": true,
"createHeader": true,
"useWorker": false,
"designAddHead": false,
"headDesignName": "random", // 头部图案注释，默认随机
"headDesign": false, // 默认关闭 开启后,所有生成头部注释的场景都会生成图案注释
"cursorModeInternalAll": {},
"openFunctionParamsCheck": true,
"functionParamsShape": ["{", "}"],
"functionBlankSpaceAll": {},
"functionTypeSymbol": " ", // 参数没有类型时的默认值
"typeParamOrder": "type param",
"customHasHeadEnd": {},
"throttleTime": 60000,
"functionParamAddStr": "",
},感谢各位的阅读，以上就是“VSCode多行注释插件KoroFileHeader如何使用”的内容了，经过本文的学习后，相信大家对VSCode多行注释插件KoroFileHeader如何使用这一问题有了更深刻的体会，具体使用情况还需要大家实践验证。这里是亿速云，小编将为大家推送更多相关知识点的文章，欢迎关注！
免责声明：本站发布的内容（图片、视频和文字）以原创、转载和分享为主，文章观点不代表本网站立场，如果涉及侵权请联系站长邮箱：is@yisu.com进行举报，并提供相关证据，一经查实，将立刻删除涉嫌侵权内容。
