PHP中用@return注释声明返回值类型,需置于函数上方DocBlock内,格式为@return 类型 说明,类型大小写敏感、联合类型用|连接,void与null不可混用,且须与PHP 8+返回类型声明兼容。

PHP里怎么给函数写返回值注释
PHP本身不强制检查返回值类型,但用@return注释能被IDE识别、生成文档、配合静态分析工具(如PHPStan、Psalm)做类型校验。关键不是“能不能写”,而是“写对格式IDE才认”。
- 必须放在函数声明上方的DocBlock里,且紧贴函数,中间不能空行
-
@return后面要跟类型,再跟可选说明(如@return string 用户昵称,空字符串表示未设置) - 类型名大小写敏感:用
string,别写String;bool不是boolean(后者虽常见但部分工具不认) - 联合类型用
|分隔,如@return int|false(注意无空格) - 泛型写法暂不被原生支持,需用
@return array这类伪泛型(PHPStan 1.10+ 支持array语法)
什么时候必须写@return注释
不是所有函数都得写,但以下场景不写就容易出问题:
- 函数可能返回
null或false(比如fopen()失败返回false),不注明IDE无法提示你判空 - 返回数组但结构固定(如
['id' => 123, 'name' => 'foo']),可用@return array{id: int, name: string}(PHPStan支持) - 返回对象实例,且调用方会链式调用(如
getUser()->getEmail()),不写@return User,IDE点不到getEmail() - 使用了PHP 8.0+的返回类型声明(如
function foo(): ?string),仍建议补@return——因为注释可比类型声明更细(比如说明“仅当缓存命中时返回非null”)
@return void和@return null的区别
这是最容易混淆的一对。PHP中void表示“不返回任何值”,null是实际返回了一个null值。
- 函数没写
return,或只写return;→ 正确注释是@return void - 函数明确
return null;→ 应写@return null,或更常用@return ?string(如果本该返回string) - 写成
@return void却实际返回null,PHPStan会报错:Function xxx() has no return statement, but return type is void - 写成
@return null但函数真没return语句,也会触发警告
/**
* 根据ID查用户,查不到返回null
* @param int $id
* @return User|null
*/
function findUser(int $id): ?User {
$row = db_query("SELECT * FROM users WHERE id = ?", [$id]);
return $row ? new User($row) : null;
}PHP 8+返回类型声明和注释冲突怎么办
优先信类型声明,注释只是补充。但两者必须兼容,否则静态分析工具直接报错。
立即学习“PHP免费学习笔记(深入)”;
- 类型声明为
string,注释写@return int→ PHPStan报错 - 类型声明为
string|null,注释写@return string→ 工具会忽略null分支,导致误报 - 推荐做法:类型声明写最简契约(如
?string),注释补业务含义(如@return ?string 用户自定义签名,null表示未设置) - 如果类型声明太宽泛(如
mixed),必须靠@return收窄,否则IDE几乎无法推导
实际项目里,最常踩的坑是以为写了PHP 8的: ?string就不用注释了——结果团队用PHPStan跑CI时,发现if ($name) { ... }被标为“可能对null调用strlen”,只因缺少@return说明这个?string在什么条件下为null。











