如何为ftp_connect返回的$connection属性编写PHPDoc类型注释？

你遇到的这个问题其实挺常见的——PHP的resource是个通用类型，但我们可以通过PHPDoc让它更精准，同时还得考虑到函数失败的情况。

首先得明确：ftp_connect()的返回值有两种可能：成功时是FTP专属资源，失败时则返回false。所以你的PHPDoc注释需要覆盖这两种情况，不管是自己后续维护代码，还是IDE的语法提示，都会更清晰。

这里有两种推荐的写法：

写法一：精准标注资源类型+失败情况 #

/**
 * @var resource(ftp)|false 通过ftp_connect()创建的FTP连接资源，连接失败时为false
 */
protected $connection;

这种写法用resource(ftp)特指FTP类型的资源，比单纯写resource更精准，主流IDE（比如PhpStorm）都能识别这种标注，会在你调用FTP相关函数时提供正确的语法提示。

写法二：通用资源类型+文字补充说明 #

如果觉得resource(ftp)不够直观，也可以用通用的resource类型，再通过注释文字补充细节：

/**
 * @var resource|false FTP连接资源（ftp_connect()的返回值），连接失败时返回false
 */
protected $connection;

一定要注意：别漏掉|false的标注——ftp_connect()在连接失败时确实会返回布尔值false，如果只写resource，后续代码里没做判断就直接使用这个属性，很容易引发错误。

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