PHPDoc - 数组中具有不同类的不同对象

Question

假设我有一个函数返回数组$ data，其中包含User对象$ user和Car对象$ car

function my_function(){
    return array(
        new User(),
        new Car()
    );
}

我的@return参数应该用于函数文档？

Answer 1

我会这样做

/**
 * @return User[]|Car[]
 */

常规|表示或，SomeType[]表示存在SomeType的数组

你确定，你不想要这个吗？

/**
 * My Parent Object
 */
class SomeClass {

    /**
     * The User
     * @var User
     */
    public $User;

    /**
     * The Car
     * @var Car
     */
    public $Car;
}

关于PHP的好（邪恶）事，你可以混合数组类型。在强大的类型语言（理由）你不能。这里我们使用Interfaces和类似的东西。我们尝试使用PHPDoc是强类型PHP。所以你应该遵循强类型语言的规则。