PHP 文档或中的注释关联数组

2022-08-30 15:39:16

我在我的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


答案 1

你不能记录每个键,但你可以告诉phpDocumentor它是什么类型

你可以做这样的事情:

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

答案 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'.
 * }
 */