Jak udokumentować tablicę z subarrayami (typu mieszanego)?

Question

celu udokumentowania zmienną, która może podjąć tablicę, która odbiera wektor, którego wartości są ciągi:

/* 
* @var string[] An array of string objects. 
*/ 
$foo = array('A', 'B', 'C'); 

udokumentować zmienną, która może podjąć tablicę, która odbiera wektor, którego wartości są liczbami całkowitymi:

/* 
* @var int[] An array of string objects. 
*/ 
$foo = array(1, 5, 0); 

Jak powinienem udokumentować zmienną, której wartościami są tablice mieszane?

muszę udokumentować tablicę takiego:

$foo = array(
    array('value A', 1, $this), 
    array('value b', 2, NULL), 
    array('value X', 15, new Test) 
); 

sobie wyobrazić, że jest coś takiego:

/* 
* @var array[][string|int|object|null] Description. 
*/ 

Answer 1

Według current draft z PHPDoc (fig PSR-5 wnioskodawcy), przy czym @ var tag to deprecated. Sugerują zamiast tego użycie @type tag.

Typ zmiennej nadal jest tablicą; zawartość tej tablicy zostanie krótko wspomniana w opisie.

/** 
* @var array $foo An array of string elements. 
*/ 

lub

/** 
* @type array $foo An array of string elements. 
*/ 

Jeśli zmienna może zawierać rzeczy inne niż ciągi, mogę powiedzieć An array of mixed elements., lub gdybym wiedział, co konkretnie mogą być An array of bool|string|object elements.

Jeśli sama zmienna może być różnych typów, dałbym listę typów, jakie może być.

/** 
* @type bool|string|array $foo Mixed type, depending on result of baz(). 
*/