PHP Documentor 中的注释关联数组

Question

我在我的 PHP 应用程序中使用了几个关联数组，并且我正在使用 PHP 文档器来注释我的源代码。我从来没有真正为数组中的数组指定 cmets，但现在我需要这样做并且不知道如何。

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

如何以正确的方式为@var 和@param cmets 注释此数组？ 我可以这样做，但我不知道这是否正确：

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

但是如何为@var 部分执行此操作？

Answer 1

对我来说，这在 PhpStorm 中可以很好地描述返回值：

/**
 * @param string $requestUri
 * @return array[
 *  'controller' => string,
 *  'action' => string
 * ]
 */

Answer 2

我会查看WordPress Inline Documentation Reference 以获得一些提示，尽管它目前并不全面。

使用@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'.
 * }
 */

Answer 3

您不能记录每个键，但you can tell phpDocumentor what type it is。

你可以这样做：

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