Question

如果函数需要传入的数组具有特定的键/索引，是否有一种雄辩的方式通过注释表达它，特别是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!';
    }
}

Answer 1

您可以编写此类密钥的列表，并将其放在@param描述中，或将其放在方法的docblock的长描述中。 phpDocumentor在这里的文档中没有任何“自动”或“严格”的内容，例如链接到其他一些记录的元素。

Answer 2

不，如果您需要特定变量，请将其设为单独的参数。在这种情况下，如果参数为空，则抛出错误。

您无法在PHP中指定数组值的数据类型。因此，有需要通过PHPDoc来记录。

Answer 3

不，没有。最好把它放在评论部分。

有没有办法通过PHPDoc指定强制数组键/索引？

3 个答案: