如何正确记录数组返回类型的键?

时间:2019-01-26 20:16:35

标签: php documentation phpdoc

class Foo
{
    /**
    *   
    * @return array
    */
    public funtion bar(): array
    {
        return [
            'x' => 1,
            'y' => 2        
        ];
    }
}

您如何正确地说明文档中bar()返回一个以arrayx作为键的y

1 个答案:

答案 0 :(得分:0)

实际上,PHP Doc尚不支持此功能(我怀疑将来会不会)...

无论如何,您都可以在@return的描述部分中编写数组结构:

/**
 * @return mixed[] Description, structured as:
 *                [
 *                   'x' => int
 *                   'y' => string
 *                ];
 */