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

【问题标题】：Is there a way to specify a mandatory array key/index via PHPDoc?有没有办法通过 PHPDoc 指定强制数组键/索引？
【发布时间】：2012-08-21 14:40:43
【问题描述】：

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

【问题讨论】：

标签： php comments phpdoc

【解决方案1】：

您可以编写一个此类键的列表，并将其放在@param 描述中，或者将其放在方法的文档块的长描述中。 phpDocumentor 在这里的文档中没有什么“自动化”或“刚性”可以真正做到的，例如链接到其他一些已记录的元素。

【讨论】：

【解决方案2】：

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

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

【讨论】：

【解决方案3】：

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

【讨论】：