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

有没有办法通过PHPDoc指定强制的数组键/索引?,php,comments,phpdoc,Php,Comments,Phpdoc,如果函数要求传入数组具有特定的键/索引,是否有一种通过注释(特别是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 th

如果函数要求传入数组具有特定的键/索引,是否有一种通过注释(特别是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中不能指定数组值的数据类型。因此,没有必要通过PHPDoc记录这些信息。

没有。最好将其放在注释部分。

您可以编写一个此类键的列表,并将其放在@param描述中,或放在方法docblock的长描述中。phpDocumentor在这里的文档中并没有真正“自动化”或“刚性”的功能,例如链接到其他文档元素