You need to enable JavaScript to run this app.
最新活动
大模型
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们

格式化PHP代码时如何保持自定义注释与代码同行且禁用自动空格插入?

这个问题我之前配置代码格式化工具时也踩过坑!不同的工具设置方式不一样,我给你整理了几种最常用的情况,你对应自己用的工具调整就行:

VS Code + 常用PHP插件

如果你用VS Code搭配Intelephense或PHP IntelliSense插件:

  1. 打开VS Code设置(快捷键Ctrl+,Cmd+,
  2. 搜索对应的选项:
    • 针对Intelephense:找到Intelephense: Formatting Space After Block Comment,把它设为false
    • 针对PHP IntelliSense:搜索PHP IntelliSense: Format Space After Block Comment,同样设为false
      这样块注释/* @text */后面就不会自动加空格了。

PHP-CS-Fixer

要是你用PHP-CS-Fixer做代码格式化,修改项目根目录下的.php-cs-fixer.php(或.php-cs-fixer.dist.php)配置文件,添加对应的规则:

return (new PhpCsFixer\Config())
    ->setRules([
        // 禁止块注释后自动添加空格
        'no_space_after_block_comment' => true,
        // 可选:避免工具把单行块注释转成PHPDoc,防止格式意外变化
        'comment_to_phpdoc' => false,
    ]);

保存配置后,重新运行格式化命令就生效了。

PhpStorm/WebStorm

对于JetBrains系列IDE:

  1. 打开设置(File > SettingsCtrl+Alt+S
  2. 导航到Editor > Code Style > PHP,切换到Spaces标签页
  3. Other区域,取消勾选After block comment选项
  4. 点击Apply保存设置,之后格式化代码就不会在块注释后加空格了。

Prettier(搭配PHP插件)

如果你用Prettier格式化PHP代码,需要在.prettierrcprettier.config.js中添加配置:

{
  "phpSpaceAfterBlockComment": false
}

注意确保你已经安装了@prettier/plugin-php插件,并且是最新版本。

内容的提问来源于stack exchange,提问作者ymakux

火山引擎 最新活动