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

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

2025-05-17 15:42:10作者:魏侃纯Zoe

在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
{
}
  1. 使用资源类型(resource)的公共属性:
/**
 * @param \resource $stream
 */
public function __construct(
    public $stream,
) {}
  1. 带有TaggedIterator属性的迭代器参数:
/** @param iterable<StoryDeBase> $stories */
public function __construct(
    #[TaggedIterator(tag: StoryDeBase::class)]
    iterable $stories
) {
}
  1. 引用参数:
/**
 * @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语言新特性和复杂类型系统时也可能遇到边缘情况。保持代码注释的简洁性和规范性,有助于减少这类工具兼容性问题。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
149
1.95 K
kernelkernel
deepin linux kernel
C
22
6
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
518
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0