Прокомментируйте ассоциативный массив в Документаторе PHP

Question

Прокомментируйте ассоциативный массив в Документаторе PHP

Я использую несколько ассоциативных массивов в своем приложении 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 часть?

19

php arrays associative-array phpdoc

задан kittykittybangbang 11 September 2015 в 18:32

1 ответ

Другие вопросы по тегам:

php arrays associative-array phpdoc

Похожие вопросы:

score 30 · Accepted Answer

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

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

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