如果函数要求传入数组具有特定的键/索引,是否有一种通过注释(特别是PHPDoc)来表达它的方法?
例如:
/**
* Just an example function
* @param array $arr My Example Array
*/
public function myFunction( $arr ){
if(!array_key_exists('mykey', $arr)){
echo 'Damnit, we needed an array that had mykey as an index!';
}
}
您可以编写一个此类键的列表,并将其放在@param描述中,或者放在方法的docblock的长描述中。phpDocumentor在这里的文档中并没有真正可以做到的"自动化"或"刚性",例如链接到其他文档元素。
否,如果您需要一个特定的变量,请将其作为一个单独的参数。在这种情况下,如果参数为空,则会引发错误。
您不能在PHP中指定数组值的数据类型。因此,没有人通过PHPDoc来记录这一点。
没有。最好把它放在评论区。