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

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 描述中，或者将其放在方法的文档块的详细描述中。phpDocumentor 在此处的文档中并不能真正做到“自动化”或“刚性”，例如链接到其他文档化元素。

Answer 2

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

您不能在 PHP 中指定数组值的数据类型。所以没有必要通过 PHPDoc 来记录。

Answer 3

不，那里没有。最好只是把它放在评论部分。