1. 在vscode的插件中心里搜索安装好用的代码注释插件 —— KoroFileHeader
2. 设置
点击左下角设置按钮==>选择“设置”>输入“fileheader”>编辑 settings.json文件
3. 编辑setting.json文件*
{
// "editor.suggestSelection": "first",
// "vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",
// "java.jdt.ls.vmargs": "-noverify -Xmx1G -XX:+UseG1GC -XX:+UseStringDeduplication -javaagent:\"C:\\Users\\sunhouxuan\\.vscode\\extensions\\gabrielbb.vscode-lombok-1.0.1\\server\\lombok.jar\"",
// "workbench.colorTheme": "βui - Tomorrow Dark",
// "workbench.startupEditor": "newUntitledFile",
// "files.autoSave": "off",
// 文件头部注释
"fileheader.customMade": {
"Descripttion": "",
"version": "",
"Author": "输入自己姓名",
"Date": "Do not edit",
"LastEditors": "输入自己姓名",
"LastEditTime": "Do not Edit"
},
"fileheader.cursorMode": {
//函数注释
"Descripttion": "",
"Author": "输入自己姓名",
"msg": "",
"param": "",
"return": ""
},
"editor.suggestSelection": "first",
"vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",
"[javascript]": {
"editor.defaultFormatter": "vscode.typescript-language-features"
},
"[less]": {
"editor.defaultFormatter": "HookyQR.beautify"
},
"[vue]": {
"editor.defaultFormatter": "octref.vetur"
},
"files.eol": "\r\n",
"java.jdt.ls.vmargs": "-XX:+UseParallelGC -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xmx1G -Xms100m -javaagent:\"c:\\Users\\sunhouxuan\\.vscode\\extensions\\gabrielbb.vscode-lombok-1.0.1\\server\\lombok.jar\"",
"[css]": {
"editor.defaultFormatter": "MikeBovenlander.formate"
},
"tabnine.experimentalAutoImports": true,
"[markdown]": {
"editor.defaultFormatter": "yzhang.markdown-all-in-one"
},
"[html]": {
"editor.defaultFormatter": "HookyQR.beautify"
},
"workbench.startupEditor": "none",
"vsicons.dontShowNewVersionMessage": true,
"fileheader.configObj": {
"createFileTime": true,
"language": {
"languagetest": {
"head": "/$$",
"middle": " $ @",
"end": " $/"
}
},
"autoAdd": 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"
],
"folderBlacklist": [
"node_modules",
"文件夹禁止自动添加头部注释"
],
"prohibitItemAutoAdd": [
"项目的全称, 整个项目禁止自动添加头部注释, 可以使用快捷键添加"
],
"moveCursor": true,
"dateFormat": "YYYY-MM-DD HH:mm:ss",
"atSymbol": [
"@",
"@"
],
"atSymbolObj": {
"文件后缀": [
"头部注释@符号",
"函数注释@符号"
]
},
"colon": [
": ",
": "
],
"colonObj": {
"文件后缀": [
"头部注释冒号",
"函数注释冒号"
]
},
"filePathColon": "路径分隔符替换",
"showErrorMessage": false,
"writeLog": false,
"wideSame": false,
"wideNum": 13,
"functionWideNum": 0,
"CheckFileChange": false,
"createHeader": true,
"useWorker": false,
"designAddHead": false,
"headDesignName": "random",
"headDesign": false,
"cursorModeInternal": false,
"openFunctionParamsCheck": true,
"functionParamsShape": [
"{",
"}"
],
"functionBlankSpace": 0,
"functionTypeSymbol": "*",
"typeParamOrder": "type param"
},
"security.workspace.trust.untrustedFiles": "open"
// 新添加
// "vetur.format.options.tabSize": 2,
// "vetur.format.options.useTabs": false,
// "vetur.format.defaultFormatter.html": "js-beautify-html",
// // "vetur.format.defaultFormatter.js": "vscode-typ=script",
// "vetur.format.defaultFormatterOptions": {
// "prettyhtml": {
// "printWidth": 100, // No line exceeds 100 characters
// "singleQuote": false // Prefer double quotes over single quotes
// },
// "js-beautify-html": {
// "wrap_attributes": "auto",
// "wrap_attributes_mode": "auto",
// "wrap-line-length": 100,
// "wrapped_attributes_per_line": "multiple",
// "wrapped_attributes_indent": "auto",
// "wrapped_attributes_end": "auto"
// }
// },
}
4. 保存settings.json文件
5.使用
(1)文件头部注释
快捷键:crtl+alt+i(window),ctrl+cmd+t (mac)
生成样式如下:
(2)函数注释
快捷键:ctrl+alt+t (window), ctrl+alt+t(mac)
函数注释不一定生成在头部,自己把控
生成样式如下:
附:异常解决
1.函数注释的快捷键 window: ctrl+alt+t 有可能因为快捷键冲突而无法使用,此时可以自己查看vscode快捷键配置:
File => Preferences => Keyboard Shorts 在搜索框内搜索:extension.cursorTip
2.直接搜索对应的fileheader、cursorTip名字,然后加上对应的快捷键即可