Как задокументировать тип возвращаемого смешанного массива?

Question

Каков правильный синтаксис для документирования массива смешанных строк и целых чисел?

public function toArray(): array
{
    return [
        'string',
        42,
    ];
}

Вот варианты, которые я рассмотрел:

/**
 * @return string|int[]
 */

Но это, кажется, указывает, что это будет либо string, либо int[]

/**
 * @return string[]|int[]
 */

И это может указывать либо на массив строк , либо на массив целых чисел.

Answer 1

Посмотрите на этот документ

в последнем последнем дне страницы

указано, содержащее несколько типов, определение типа информирует читателя о типе каждого элемента массива. Каждый элемент может быть любого из указанных типов.

 @return (int|string)[]

Также обратите внимание на return в случае необходимости более подробной информации.

Answer 2

Вы можете использовать

@return (int|string)[]

Подробнее о phpdoc