在VS+PHPTools环境消除PHP0421变量赋值未使用警告的非重构方法

我在启用PHPTools的Visual Studio里写了这段PHP代码：

foreach ($row['bgcolor'] as &$colBgColor) {
    $colBgColor = Color::COLOR_HEADER;
}

VS错误列表里弹出警告：PHP0421 变量'$colBgColor'已被赋值，但从未使用其值。我知道可以重构代码消除这个警告，但想找非重构的方式——比如注解、PHPTools配置——来移除它。我试过在foreach上方加以下注解，都没用：

• @psalm-suppress PHP0421
• @phpstan-ignore-next-line
• @var string $colBgColor 和 @psalm-ignore-var
• @psalm-property-write string $colBgColor

可行的解决方法 #

方法1：使用PHPTools原生抑制注解 #

PHPTools有自己的抑制注释语法，直接在目标代码上方或行尾添加：

// @suppress PHP0421
foreach ($row['bgcolor'] as &$colBgColor) {
    $colBgColor = Color::COLOR_HEADER;
}

或者在行内标注：

foreach ($row['bgcolor'] as &$colBgColor) { // @suppress PHP0421
    $colBgColor = Color::COLOR_HEADER;
}

方法2：全局配置禁用该规则 #

如果不想逐个处理，可以通过PHPTools的全局配置关闭PHP0421警告：

1. 打开Visual Studio的「工具」→「选项」
2. 找到「PHP Tools」→「Analysis」
3. 在「Diagnostics」列表里找到PHP0421，将其严重程度改为「None」，或者直接取消勾选

方法3：项目级配置文件 #

在项目根目录创建php.tools.config文件，添加以下内容来禁用该规则：

{
  "analysis": {
    "diagnostics": {
      "PHP0421": "disabled"
    }
  }
}

内容的提问来源于stack exchange，提问作者1stthomas