w

VSCode系列-09:VS Code 开发环境配置 —— 插件篇

VSCode系列-09:VS Code 开发环境配置 —— 插件篇
该条目是 第 9 部分,共 10 在系列中 VSCode配置

VSCode配置

VSCode系列-01:VS Code 纯净版安装、全局 settings.json 核心参数硬核优化与多端配置同步

VSCode系列-02:破除卡顿:VS Code 内存极限优化、禁用无用内置功能与秒级启动调优

VSCode系列-03:前端开发与排版全装:Prettier 自动格式化、Auto Rename Tag 与 Error Lens 降维打击

VSCode系列-04:远程全栈运维神器:Remote-SSH 极限免密配置与 GitLens 团队版本控制全攻略

VSCode系列-05:Markdown 全能强化:Markdown All in One 语法增强与代码块一键美化包

VSCode系列-06:AI 代码外挂(Copilot&Cursor)无缝注入与十个受用一生的 VS Code 核心快捷键

VSCode系列-07:调试器(Debugger)深度实战 + 断点技巧与变量监视面板

VSCode系列-08:VSCode资源管理器行高、字体大小修改

VSCode系列-09:VS Code 开发环境配置 —— 插件篇

VSCode系列-10:VS Code 开发环境配置 —— 设置篇

🤖 摘要:本文系统整理了VS Code开发环境的核心插件配置指南。涵盖PHP代码提示、Xdebug调试与php-cs-fixer格式化、SQL数据库支持,以及文件头注释、代码高亮与实时预览等工具。详细记录安装步骤、关键配置与快捷键,助力打造规范高效的开发工作流。

一、PHP 插件

1. 预先配置php.exe可执行文件路径

配置保存:

"php.validate.executablePath": "E:/php/env/php-8.0.3/php.exe",  
"php.executablePath": "E:/php/env/php-8.0.3/php.exe"

2. PHP Intelephense – 代码格式化、提示、补全、类方法定位等

(1. 安装

(2. 配置

(3. 效果

(4. 常用快捷键

代码格式化: Mac: shift + option + f ; Windows:shift + alt + f

类或方法定位: Mac:command + 鼠标左健 ;Windows:ctrl + 鼠标左键

返回到上次跳转位置: Mac:control + “-” ;Windows:alt + 左箭头

3. Php-docblocker – 快速类、函数注释

(1. 安装

(2. 配置

 {  
     "php-docblocker.extra": [  
         "@Author xiaojin",  
         "@DateTime $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE"  
     ],  
     "php-docblocker.author": {  
         "name": "xxx"  
     },  
     "php-docblocker.classTemplate": {  
         "message": {},  
         "author": {  
             "content": "@author xxx"  
         }  
     },  
     "php-docblocker.functionTemplate": {  
         "message": {},  
         "extra": {},  
         "param": {},  
         "return": {},  
     }  
 }

(3. 效果

4. Php Namespace Resolver – 支持命名空间解析器、引入类

快捷键:ctrl + alt + i

5. Php Debug – 调试插件

(1. 先下载安装php的 Xdebug 扩展库(php线程版下ts版的),下载地址:https://xdebug.org/download

(2. 将扩展放到php指定扩展库目录

(3. 修改php配置文件php.ini,末行新增如下debug配置(根据需要配置),后重启web服务(apache等)

php.ini配置参考:https://xdebug.org/docs/step_debug

所有配置说明:https://xdebug.org/docs/all_settings#mode

 [xdebug]  
 ;xdebug3扩展  
 zend_extension = "E:\php\env\php-8.0.3\ext\php_xdebug-3.0.3-8.0-vs16-x86_64.dll"  
 ;xdebug3与xdebug2配置不同,配置参考https://xdebug.org/docs/step_debug#start_with_request  
 ;设置debug模式  
 xdebug.mode=debug  
 ;激活debug  
 xdebug.start_with_request=yes  
 ;允许不同机器访问  
 ;xdebug.discover_client_host = false   
 ;远程主机 默认localhost  
 ;xdebug.client_host=localhost  
 #远程端口  
 xdebug.client_port = 9000

(4. Vscode 应用商店搜索安装“php debug”

(5. 创建lunch.json文件,弹出语言列表选择php,配置内容中只需确保端口无误,其他默认配置就好

(6 添加断点,启动并可进入调试状态

说明:利用“php debug”插件便可以预览运行结果或直接在终端访问“php 文件名”,若想运行更多编程语言,推荐插件“Code Runner”,运行页面效果直接浏览器访问。

6. Php cs fixer – 代码格式化

(1. 安装

(2. 配置

 "php-cs-fixer.executablePath": "php-cs-fixer",  
 "php-cs-fixer.executablePathWindows": "", //eg: php-cs-fixer.bat  
 "php-cs-fixer.onsave": true,  
 "php-cs-fixer.rules": "@PSR12",  
 "php-cs-fixer.config": ".php-cs-fixer.php;.php-cs-fixer.dist.php;.php_cs;.php_cs.dist",  
 "php-cs-fixer.allowRisky": false,  
 "php-cs-fixer.pathMode": "override",  
 "php-cs-fixer.ignorePHPVersion": false,  
 "php-cs-fixer.exclude": [],  
 "php-cs-fixer.autoFixByBracket": false,  
 "php-cs-fixer.autoFixBySemicolon": false,  
 "php-cs-fixer.formatHtml": true,  
 "php-cs-fixer.documentFormattingProvider": true,

7. PHP Snippets from PHPStorm – Phpstorm 的实时模板中的代码片段

二、SQL 插件

  • SQL Server – Microsoft SQL Server数据库支持

  • MongoDB for VS Code – MongoDB数据库支持,简化MongoDB的开发流程。

三、其他插件

  • vscode-icons – VSCode官方出品的图标库,增强文件和文件夹的视觉识别。

  • Highlight Matching Tag – 突出显示匹配的HTML和JSX标签,优化前端开发体验。

配置:

"highlight-matching-tag.styles": {  
 "opening": {  
     "left": {  
         "underline": "yellow"  
     },  
     "right": {  
         "surround": "#155FFA"  
     },  
     "name": {  
         "highlight": "rgba(180, 20, 80, 0.3)"  
     }  
 },  
 "closing": {  
     "full": {  
         "custom": {  
             "dark": {  
                 "borderWidth": "0 0 1px 0",  
                 "borderColor": "white",  
                 "borderStyle": "solid",  
                 "borderRadius": "4px",  
                 "right": "10px"  
             },  
             "light": {  
                 "borderWidth": "0 0 1px 0",  
                 "borderColor": "brown",  
                 "borderStyle": "solid",  
                 "borderRadius": "4px",  
                 "right": "10px"  
             }  
         }  
     }  
 }  
}
  • auto close tag & auto rename tag – 自动添加、修改、重命名 HTML 标签

  • Better Comments – 注释美化

配置:

"better-comments.tags": [  
 {  
     "tag": "!",  
     "color": "#FF2D00",  
     "strikethrough": false,  
     "underline": false,  
     "backgroundColor": "transparent",  
     "bold": false,  
     "italic": false  
 },  
 {  
     "tag": "?",  
     "color": "#3498DB",  
     "strikethrough": false,  
     "underline": false,  
     "backgroundColor": "transparent",  
     "bold": false,  
     "italic": false  
 },  
 {  
     "tag": "//",  
     "color": "#474747",  
     "strikethrough": true,  
     "underline": false,  
     "backgroundColor": "transparent",  
     "bold": false,  
     "italic": false  
 },  
 {  
     "tag": "todo",  
     "color": "#FF8C00",  
     "strikethrough": false,  
     "underline": false,  
     "backgroundColor": "transparent",  
     "bold": false,  
     "italic": false  
 },  
 {  
     "tag": "*",  
     "color": "#98C379",  
     "strikethrough": false,  
     "underline": false,  
     "backgroundColor": "transparent",  
     "bold": false,  
     "italic": false  
 }  
]
  • Chinese (Simplified) (简体中文) Language Pack for Visual Studio Code – 中文汉化

  • Code Runner – 脚本运行

配置:

"code-runner.executorMap": {  
     "javascript": "node",  
     "php": "C:\\php\\php.exe",  
     "python": "python",  
     "perl": "perl",  
     "ruby": "C:\\Ruby23-x64\\bin\\ruby.exe",  
     "go": "go run",  
     "html": "\"C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe\"",  
     "java": "cd $dir && javac $fileName && java $fileNameWithoutExt",  
     "c": "cd $dir && gcc $fileName -o $fileNameWithoutExt && $dir$fileNameWithoutExt"  
}
  • Code Spell Checker – 拼写检查

  • Error Lens – 错误信息高亮显示

  • ESLint – 前端神器

  • Github Copilot & Github Coplit Chat – AI 编程

  • Hooks IntelliSense for WordPress – WordPress 钩子

  • indent-rainbow – 缩进高亮

  • IntelliSense for CSS class names in HTML

配置:

"html-css-class-completion.enableEmmetSupport": true,  
"html-css-class-completion.CSSLanguages": ["css", "sass", "scss"],  
"html-css-class-completion.HTMLLanguages": [  
     "html",  
     "vue",  
     "razor",  
     "blade",  
     "handlebars",  
     "twig",  
     "django-html",  
     "php",  
     "markdown",  
     "erb",  
     "ejs",  
     "svelte"  
] // false is the default
  • JavaScript (ES 6) code snippets – ES 6 插件

  • jQuery Code Snippets – jQuery 插件

  • Json – JSON 美化

  • Live Server – 实时预览

配置:

"liveServer.settings.ChromeDebuggingAttachment": true,  
"liveServer.settings.CustomBrowser": "chrome",  
"liveServer.settings.port": 1015,  
"liveServer.settings.host": "192.168.1.8"
  • npm Intellisense

配置:

"npm-intellisense.importES6": true,  
"npm-intellisense.importQuotes": "'",  
"npm-intellisense.importLinebreak": ";\r\n",  
"npm-intellisense.importDeclarationType": "const",
  • Path Intellisense – 智能路径提示

配置:

"typescript.suggest.paths": true,  
"javascript.suggest.paths": true,  
"path-intellisense.extensionOnImport": true,  
"path-intellisense.showHiddenFiles": true,  
"path-intellisense.autoTriggerNextSuggestion": true,
  • php cs fixer – php 代码格式化

配置:

"php-cs-fixer.executablePath": "php-cs-fixer",    
"php-cs-fixer.executablePathWindows": "", //eg: php-cs-fixer.bat    
"php-cs-fixer.onsave": false,    
"php-cs-fixer.rules": "@PSR12",    
"php-cs-fixer.config": ".php-cs-fixer.php;.php-cs-fixer.dist.php;.php_cs;.php_cs.dist",    
"php-cs-fixer.allowRisky": false,    
"php-cs-fixer.pathMode": "override",    
"php-cs-fixer.ignorePHPVersion": false,    
"php-cs-fixer.exclude": [],    
"php-cs-fixer.autoFixByBracket": false,    
"php-cs-fixer.autoFixBySemicolon": false,    
"php-cs-fixer.formatHtml": false,    
"php-cs-fixer.documentFormattingProvider": true
  • Prettier – Code formatter – 代码美化

  • Python

  • Regex Previewer

  • Remote – SSH

配置:

  • Shopify Liquid

  • svg preview

  • TODO Highlight

配置:

"todohighlight.isEnable": true,  
"todohighlight.isCaseSensitive": true,  
"todohighlight.keywords": [  
  "DEBUG:",  
  "REVIEW:",  
  {  
    "text": "NOTE:",  
    "color": "#ff0000",  
    "backgroundColor": "yellow",  
    "overviewRulerColor": "grey"  
  },  
  {  
    "text": "HACK:",  
    "color": "#000",  
    "isWholeLine": false  
  },  
  {  
    "text": "TODO:",  
    "color": "red",  
    "border": "1px solid red",  
    "borderRadius": "2px", //NOTE: using borderRadius along with `border` or you will see nothing change  
    "backgroundColor": "rgba(0,0,0,.2)"  
    //other styling properties goes here ...  
  }  
],  
"todohighlight.keywordsPattern": "TODO|FIXME", //highlight `TODO:`,`FIXME:` or content between parentheses  
"todohighlight.defaultStyle": {  
  "color": "red",  
  "backgroundColor": "#ffab00",  
  "overviewRulerColor": "#ffab00",  
  "cursor": "pointer",  
  "border": "1px solid #eee",  
  "borderRadius": "2px",  
  "isWholeLine": true  
  //other styling properties goes here ...  
},  
"todohighlight.include": [  
  "**/*.js",  
  "**/*.jsx",  
  "**/*.ts",  
  "**/*.tsx",  
  "**/*.html",  
  "**/*.php",  
  "**/*.css",  
  "**/*.scss"  
],  
"todohighlight.exclude": [  
  "**/node_modules/**",  
  "**/bower_components/**",  
  "**/dist/**",  
  "**/build/**",  
  "**/.vscode/**",  
  "**/.github/**",  
  "**/_output/**",  
  "**/*.min.*",  
  "**/*.map",  
  "**/.next/**"  
],  
"todohighlight.maxFilesForSearch": 5120,  
"todohighlight.toggleURI": false,
  • Trailing Spaces

  • vscode-faker

  • vue 3 snippets

  • woocommerce – snippets & autocomplete

  • WordPress Snippets

  • autoDocstring – Python Docstring Generator

  • CSS Peek

  • Django

  • IntelliCode & IntelliCode API

  • LeetCode

  • EditorConfig for VS Code – 统一代码风格,保持代码的一致性。

  • change-case – 快速更改变量命名风格,适应不同编程语言的规范。

  • css-auto-prefix – 自动添加CSS前缀,保持CSS代码的兼容性

  • Sort lines – 对文本进行排序,简化数据处理

  • Data Preview – 预览数据文件,快速理解数据内容。

  • koroFileHeader

配置:

// 头部注释  
"fileheader.customMade": {  
    // 头部注释默认字段  
    "Author": "your name",  
    "Date": "Do not edit", // 设置后默认设置文件生成时间  
    "LastEditTime": "Do not edit", // 设置后,保存文件更改默认更新最后编辑时间  
    "LastEditors": "your name", // 设置后,保存文件更改默认更新最后编辑人  
    "Description": "",  
    "FilePath": "Do not edit", // 设置后,默认生成文件相对于项目的路径  
    "custom_string_obkoro1": "可以输入预定的版权声明、个性签名、空行等"  
},  
// 函数注释  
"fileheader.cursorMode": {  
  // 默认字段  
  "description":"",  
  "param":"",  
  "return":""  
},  
// 插件配置项  
"fileheader.configObj": {  
    "autoAdd": true, // 检测文件没有头部注释,自动添加文件头部注释  
    "autoAddLine": 100, // 文件超过多少行数 不再自动添加头部注释  
    "autoAlready": true, // 只添加插件支持的语言以及用户通过`language`选项自定义的注释  
    "supportAutoLanguage": [], // 设置之后,在数组内的文件才支持自动添加  
   // 自动添加头部注释黑名单  
   "prohibitAutoAdd": [  
      "json"  
    ],  
   "prohibitItemAutoAdd": [ "项目的全称禁止项目自动添加头部注释, 使用快捷键自行添加" ],  
   "folderBlacklist": [ "node_modules" ], // 文件夹或文件名禁止自动添加头部注释  
   "wideSame": false, // 头部注释等宽设置  
   "wideNum": 13,  // 头部注释字段长度 默认为13  
    "functionWideNum": 0, // 函数注释等宽设置 设为0 即为关闭  
   // 头部注释第几行插入  
    "headInsertLine": {  
      "php": 2 // php文件 插入到第二行  
    },  
    "beforeAnnotation": {}, // 头部注释之前插入内容  
    "afterAnnotation": {}, // 头部注释之后插入内容  
    "specialOptions": {}, // 特殊字段自定义  
    "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": false, // 单个文件保存时进行diff检查  
    "createHeader": true, // 新建文件自动添加头部注释  
    "useWorker": false, // 是否使用工作区设置  
    "designAddHead": false, // 添加注释图案时添加头部注释  
    "headDesignName": "random", // 图案注释使用哪个图案   
    "headDesign": false, // 是否使用图案注释替换头部注释  
    // 自定义配置是否在函数内生成注释 不同文件类型和语言类型  
    "cursorModeInternalAll": {}, // 默认为false 在函数外生成函数注释  
    "openFunctionParamsCheck": true, // 开启关闭自动提取添加函数参数  
    "functionParamsShape": ["{", "}"], // 函数参数外形自定义   
    // "functionParamsShape": "no type" 函数参数不需要类型  
    "functionBlankSpaceAll": {}, // 函数注释空格缩进 默认为空对象 默认值为0 不缩进  
    "functionTypeSymbol": "*", // 参数没有类型时的默认值  
    "typeParamOrder": "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": {  
          "head": "/*** ", // 统一增加几个*号  
          "middle": " * @",  
          "end": " */"  
        },  
        // 针对有特殊要求的文件如:test.blade.php  
        "blade.php":{  
          "head": "<!--",  
          "middle": " * @",  
          "end": "-->",  
        }  
    },  
 // 默认注释  没有匹配到注释符号的时候使用。  
 "annotationStr": {   
      "head": "/*",  
      "middle": " * @",  
      "end": " */",  
      "use": false  
    },  
}
  • HTML CSS Support

  • Easy LESS

  • CSS Peek

  • Microsoft Edge Tools for VS Code

  • DotENV

  • Icon Fonts

code –install-extension idleberg.icon-fonts

  • vscode-element-helper

配置:

"element-helper.language": "zh-CN",  
"element-helper.version": "1.3",  
"element-helper.indent-size": 2,  
"element-helper.quotes": "double",    // html vue qoutes  
"element-helper.pug-quotes": "single" // jade/pug quotes
  • Search node_modules

  • Tailwind CSS IntelliSense

VSCode配置

VSCode系列-08:VSCode资源管理器行高、字体大小修改 VSCode系列-10:VS Code 开发环境配置 —— 设置篇