vscode扩展应用 -koroFileHeader(jsdoc代码风格注释)
安装后,在settings.json中配置
{"eslint.validate": ["javascript","javascriptreact","html","vue"],"eslint.options": {"plugins":["html"]},"emmet.syntaxProfiles": {"vue-html":"html","vue":"html"},"editor.fontLigatures": false,"editor.mouseWheelZoom": true,"vetur.completion.scaffoldSnippetSources": {"workspace": "💼","user": "🗒️","vetur": "✌"},"eslint.codeActionsOnSave.rules": null,"cssrem.rootFontSize": 80,"liveServer.settings.donotShowInfoMsg": true,"editor.unicodeHighlight.includeComments": false,"[javascript]": {"editor.defaultFormatter": "esbenp.prettier-vscode"},"[vue]": {"editor.defaultFormatter": "esbenp.prettier-vscode"},"workbench.tree.indent": 24,"[html]": {"editor.defaultFormatter": "HookyQR.beautify"},"workbench.editorAssociations": {"*.copilotmd": "vscode.markdown.preview.editor","*.glb": "default"},"vue.autoInsert.dotValue": true,"editor.semanticTokenColorCustomizations": {},"editor.tokenColorCustomizations": {"[*Light*]": {"textMateRules": [{"scope": "ref.matchtext","settings": {"foreground": "#000"}}]},"[*Dark*]": {"textMateRules": [{"scope": "ref.matchtext","settings": {"foreground": "#fff"}}]}},"fileheader.configObj": {"createFileTime": true,"language": {"languagetest": {"head": "/$$","middle": " $ @","end": " $/","functionSymbol": {"head": "/** ","middle": " * @","end": " */"},"functionParams": "js"}},"autoAdd": true,// 检测文件没有头部注释,自动添加文件头部注释,配合头部注释黑名单使用更佳"autoAddLine": 100,// 文件超过多少行数 不再自动添加头部注释"autoAlready": true,// 只添加插件支持的语言以及用户通过`language`选项自定义的注释"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,"cursorModeInternalAll": {},"openFunctionParamsCheck": true,"functionParamsShape": ["{","}"],"functionBlankSpaceAll": {},"functionTypeSymbol": "*","typeParamOrder": "type param","customHasHeadEnd": {},"throttleTime": 60000,"functionParamAddStr": "","NoMatchParams": "no show param"},"fileheader.customMade": {// 在文件头部插入注释 【快捷键 ctrl+win+j /ctrl+alt+M】 【建议一个文件不超过300行,配置文件除外】"Description": "enter your description", // 文件描述描述,【必填】"Autor": "git config user.name", // 作者,【自动填写】"Date": "Do not edit", // 创建时间 ,【自动填写】"LastEditTime": "Do not edit" // 最后更改时间 ,【自动填写】},"fileheader.cursorMode": {// 在光标处插入注释【快捷键 ctrl+alt+p】"description": "enter your description", // 函数功能描述,【必填】"param": "", // 参数值,可不填,【建议,不要有过多的参数,建议不超过3个参数,如果超过,请使用字典方式组织参数】"return": "", // 返回值,可不填 optional// "author": "git config user.name", // 作者,【自动填写】"Date": "Do not edit", // 创建注释的时间,【自动填写】},"remote.SSH.remotePlatform": {"dev-server": "linux"},"vue-helper.framework": "element-plus"}