Есть ли способ указать обязательный массив ключ / индекс через 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, или поместить в подробное описание docblock метода. Здесь нет ничего "автоматизированного" или "жесткого", которое phpDocumentor мог бы реально сделать в документации, например, ссылка на какой-то другой документированный элемент.

Answer 2

НЕТ там нет. Лучше всего просто положить его в разделе комментариев.

Answer 3

Нет, если вам нужна конкретная переменная, сделайте ее отдельным параметром. В этом случае, если параметр пуст, выдается ошибка.

Вы не можете указать тип данных значений массива в PHP. Так что нет необходимости документировать это через PHPDoc.