PHP-CS-Fixer 3.61.0版本中no_superfluous_phpdoc_tags规则引发的AssertionError问题解析

在PHP代码格式化工具PHP-CS-Fixer的最新版本3.61.0中，一个名为no_superfluous_phpdoc_tags的规则引发了多个AssertionError异常。这个问题主要出现在处理特定类型的PHPDoc注释时，特别是当注释与参数属性或引用参数结合使用时。

问题现象

当开发者升级到3.61.0版本后，运行PHP-CS-Fixer时会遇到以下两种主要错误：

1. AssertionError异常，提示"assert(0 !== \count($types))"
2. ErrorException异常，提示"Undefined offset: 0"

这些错误通常发生在以下几种代码场景中：

1. 带有SensitiveParameter属性的数组参数：

/**
 * @param array<string, string> $data
 */
public function someMethod(#[SensitiveParameter] array $data): void
{
}

2. 使用资源类型(resource)的公共属性：

/**
 * @param \resource $stream
 */
public function __construct(
    public $stream,
) {}

3. 带有TaggedIterator属性的迭代器参数：

/** @param iterable<StoryDeBase> $stories */
public function __construct(
    #[TaggedIterator(tag: StoryDeBase::class)]
    iterable $stories
) {
}

4. 引用参数：

/**
 * @param string $cost
 */
public function calculate(&$cost)
{
}

技术分析

这个问题源于3.61.0版本中对no_superfluous_phpdoc_tags规则的改进。该规则原本用于移除冗余的PHPDoc注释，但在处理某些特殊语法结构时出现了逻辑缺陷。

核心问题出现在toComparableNames方法中，该方法在处理参数类型时做出了不正确的假设。特别是当遇到以下情况时：

1. 带有属性的参数（PHP 8.0+特性）
2. 引用参数（&$variable语法）
3. 复杂类型注释（如泛型语法array<string, string>）

在这些情况下，类型解析逻辑未能正确处理空类型数组或无效类型的情况，导致断言失败或数组越界访问。

临时解决方案

对于受影响的用户，可以考虑以下临时解决方案：

1. 降级到3.60.0版本
2. 在配置中暂时禁用no_superfluous_phpdoc_tags规则
3. 修改代码中的PHPDoc注释格式：
   • 将@param注释改为内联的@var注释
   • 移除引用参数的PHPDoc注释

开发者响应

PHP-CS-Fixer团队已经意识到这个问题，并正在积极修复。预计在下一个版本中会包含针对此问题的修正补丁。修复方向主要包括：

1. 增强类型解析的健壮性，处理空类型数组情况
2. 改进对属性参数和引用参数的支持
3. 添加更多边界测试用例

最佳实践建议

为避免类似问题，建议开发者在升级静态分析工具时：

1. 先在开发环境测试，再应用到生产环境
2. 关注项目的CHANGELOG，了解重大变更
3. 考虑在CI流程中分阶段升级，先在小范围代码库测试

这个问题提醒我们，即使是成熟的代码格式化工具，在处理PHP语言新特性和复杂类型系统时也可能遇到边缘情况。保持代码注释的简洁性和规范性，有助于减少这类工具兼容性问题。