Question

说我有这样的功能：

function theFunction() {
    $arr = array();
    for ($i=0;$i<10;$i++) {
        $arr[] = new theObject($i);
    }
    return $arr;
}

我需要记录函数的返回类型。我当然可以使用array，但这并不能提供所有可以提供的信息，也不会告诉开发人员很多关于函数的真实性质。

如何在PHPDoc中记录“[type]”类型的类型？

Answer 1

来自phpDocumentor

的文档

Type表示的值可以是数组。必须按照以下选项之一的格式定义类型：



未指定，未给出所代表数组内容的定义。示例：@return array



指定包含单个类型，Type定义通知读者每个数组元素的类型。然后只需要一个Type作为给定数组的元素。

示例：@return int[]

请注意，mixed也是单一类型，使用此关键字可以指示每个数组元素包含任何可能的类型。



指定包含多个类型，类型定义会通知读者每个数组元素的类型。每个元素可以是任何给定类型。示例：@return (int|string)[]

注意
  许多IDE可能还不支持这种表示法。

Answer 2

如果我记得对，你提供了返回类型和说明，你能不能把它放在描述中？

/**
 * blah
 * @return array array of types
 */

Answer 3

在PHPDoc中，您可以对类型提示数组成员执行以下操作：

@var array<\My\Folder\ClassName>

如何记录[type]数组？

3 个答案: