【发布时间】:2013-01-14 18:52:30
【问题描述】:
可能重复:
Is there a way for phpDoc to document an array of objects as a parameter?
我一直在搜索,并查看了 phpDocumentor 文档,但找不到是否有办法正确记录 @param 数组(如,声明预期的键/值类型),该数组将被解析并包含在任何生成的文档。
这会让我相信没有办法做到这一点,我将不得不使用描述。
提前致谢。
【问题讨论】:
可能重复:
Is there a way for phpDoc to document an array of objects as a parameter?
我一直在搜索,并查看了 phpDocumentor 文档,但找不到是否有办法正确记录 @param 数组(如,声明预期的键/值类型),该数组将被解析并包含在任何生成的文档。
这会让我相信没有办法做到这一点,我将不得不使用描述。
提前致谢。
【问题讨论】:
@param YourType[] 至少被 Eclipse/Zend Studio 识别。我不知道其他 IDE 的情况,但我会期望相同,即使这可能不是官方的 phpDocumentor 语法。
但是我不知道有什么方法可以记录键的类型(无论如何都限于 int 和 string)。
【讨论】:
array( 'key1'=>'value1', 'key2'=>2, 'key3'=>array( 'key4'=>'value4' ) ) 看来这可能是重复的。链接的问题有一个看起来可行的答案。我会尝试并报告。
(string|int|string[])[] 或简单的mixed[](语义上等于array)
key1。更新:正在讨论github.com/phpDocumentor/phpDocumentor2/issues/650