Ассоциативный массив комментариев в PHP Documentor

Question

Я использую несколько ассоциативных массивов в своем PHP-приложении и использую PHP-документатор для комментирования своих источников. Я никогда не задавал комментарии для массивов в массиве, но теперь мне нужно это сделать, и я не знаю, как.

$array = array('id' => 'test', 'class' => 'tester', 'options' => array('option1' => 1, 'option2' => 2))

Как правильно комментировать этот массив для комментариев @var и @param? Я мог бы сделать это так, но я не знаю, правильно ли это:

@param string $array['id']
@param string $array['class']
@param int $array['options']['option1']

Но как это сделать для @var части?

Answer 1

Вы не можете документировать каждый ключ, но вы можете сказать phpDocumentor, какой это тип .

Вы можете сделать что-то вроде этого:

/**
 * Form the array like this:
 * <code>
 * $array = array(
 *   'id'      => 'foo',          // the id
 *   'class'   => 'myClass',     // the class
 * );
 * 
 * </code>
 *
 * @var array[string]string 
 */
$array;

Answer 2

Я бы посмотрел на Справочник по встроенной документации WordPress для некоторых подсказок, хотя в настоящее время он не является полным.

Используйте @param или @var или @property, в зависимости от того, что подходит для вашего контекста

В соответствии с этими рекомендациями вы можете задокументировать свой ассоциативный массив следующим образом:

/**
 * @property array $my_array {
 *     An array of parameters that customize the way the parser works.
 *
 *     @type boolean $ignore_whitespace Whether to gobble up whitespace. Default true.
 *     @type string $error_level What the error reporting level is. Default 'none'.
 *                               Accepts 'none', 'low', 'high'.
 * }
 */