讲师中心 微信公众号
AI工具推荐 视频效率加速

如何编写支持PHP8泛型的PHPDoc

陌宇酱_7932

陌宇酱_7932

发布时间:2026-09-09 17:48:09

|

694人浏览过

|

来源于php中文网

原创

PHP 本身不支持泛型,但可通过 PHPDoc 的 @template 注解配合 PHPStan、Psalm 和 PhpStorm 实现泛型语义:@template T 声明类型参数,@param T $x 和 @return array 等标签引用以实现类型推导与智能提示,需注意工具兼容性及正确上下文约束。

如何编写支持php8泛型的phpdoc

PHP 本身不支持泛型(如 T、array<t></t>),但 PHPStan、Psalm 和现代 IDE(如 PhpStorm)可通过 PHPDoc 注解理解泛型语义。PHP 8.0+ 虽未引入语言级泛型,但其类型系统增强(如联合类型、static 返回、模板化注解)让 PHPDoc 泛型标注更可靠、更易被工具识别。

使用 @template 声明泛型类型参数

这是 PHPDoc 泛型标注的核心。它告诉静态分析工具:这个类/方法/函数有一个可变的类型占位符。

  • 必须放在类、接口、trait 或函数的 PHPDoc 块顶部(紧贴声明前)
  • 语法为 @template T,可带约束:@template T of iterable 或 @template TKey of array-key
  • 支持多个泛型:@template T @template U of string

示例:

  /**
   * @template T
   * @template U of string
   */
  class Mapper { /* ... */ }
  ?>

在类型声明中引用泛型(@param、@return、@var)

声明后即可在其他 PHPDoc 标签中使用泛型名,实现“类型传递”效果。

立即学习“PHP免费学习笔记(深入)”;

PHP 8.5.12
PHP 8.5.12

修复 Core bailout 状态损坏安全问题,以及 BZ2、DOM、PDO、Opcache/JIT 内存与执行错误,改进 Unicode 字素处理、URL 解析、TLS 流状态、信号分发及会话错误处理。

下载
  • @param T $value 表示参数类型与声明的 T 一致
  • @return array<t></t> 表示返回值是 T 类型元素的数组
  • @return self<t></t> 在泛型类中表示返回相同泛型实例(需配合 @template 类级声明)
  • 支持嵌套和组合:array<string array t>></string>、T|null

示例(泛型方法):

  /**
   * @template T
   * @param array $items
   * @return T
   */
  function first(array $items): mixed {
    return $items[0] ?? null;
  }
  ?>

用 @extends、@implements、@uses 传递泛型上下文

当继承/实现泛型类或接口时,需显式指定泛型实参,否则工具无法推断子类的类型关系。

  • @extends Collection<user></user> —— 子类固定泛型为 User
  • @extends Collection<t></t> —— 子类保持父类泛型(需先声明 @template T)
  • @implements IteratorAggregate<string product></string>
  • @uses HasTimestamps<t></t>(用于 trait 使用场景)

示例:

  /**
   * @template T
   * @extends ArrayObject
   */
  class TypedArray extends ArrayObject {}
  ?>

注意兼容性与工具差异

不同工具对 PHPDoc 泛型的支持程度略有不同,实际编写时需兼顾。

  • PHPStan(v1.10+)完整支持 @template、@extends 泛型推导,推荐开启 phpstan.neon 中的 checkGenericClassInNonGenericObjectType: true
  • Psalm 使用 @psalm-template(兼容 @template),但对 self<t></t> 推断更严格,建议优先用 @psalm-return static<t></t>
  • PhpStorm 基于 PHPStan 规则解析,支持跳转、补全、类型提示,但不校验约束(如 of Traversable)
  • 避免在 @var 中单独写 @var T(无上下文),应配合 @template 声明或明确作用域(如方法内 @var T $x)

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

12144

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

6941

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2215

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

4428

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

5134

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

4031

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

5837

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

4582

2023.11.13

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

0

2026.11.03

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn