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

Phpstorm 中的工作原理是：

/**
 * @return array{ hand: Hand, card: CardType | null }
 */

Answer 3

我会看看 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'.
 * }
 */

Answer 4

对我来说，这在 PhpStorm 中工作得很好，可以获得很好的返回值描述：

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