以下哪种是记录 phpDocumentor 此方法返回类型的正确方法?
方法一:
/**
* @return array Foo array.
*/
public function foo() {
return array(1, 2, 3);
}
方法2:
/**
* @return integer[] Foo array.
*/
public function foo() {
return array(1, 2, 3);
}
另外,这两种方法是否有任何 IDE 含义?
编辑:
看来 PhpStorm 和 Netbeans 7.1+ IDE 都支持第二种方法。
这两种方法在技术上都是正确的,但这种方法被认为是"更好的",因为它更具体(int
和integer
是可以互换的):
@return int[]
记录在这里:
http://www.phpdoc.org/docs/latest/guides/types.html
在写这个答案的时候,这些是phpDocumentor(可能还有其他PHPDoc实现)表示数组的公认方式:
未指定,表示数组的内容没有定义 鉴于。示例:
@return array
指定包含单个类型,
Type
定义通知 每个数组元素类型的读取器。然后只有一个Type
预期为给定数组的元素。 示例:@return int[]
请注意,mixed
也是单一类型,使用此关键字 可以指示每个数组元素包含任何可能的 类型。- 指定包含多个类型,
Type
定义通知 每个数组元素类型的读取器。每个元素可以是任何 给定的类型。示例:@return (int|string)[]