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

Question

class Foo
{
    /**
    *   
    * @return array
    */
    public funtion bar(): array
    {
        return [
            'x' => 1,
            'y' => 2        
        ];
    }
}

Как правильно указать в документации, что bar() возвращает array с x и y в качестве ключей?

Answer 1

На самом деле это еще не поддерживается в PHP Doc (и я сомневаюсь, что это произойдет в будущем) ...

В любом случае, вы можете написать структуру массива в части описания @return:

/**
 * @return mixed[] Description, structured as:
 *                [
 *                   'x' => int
 *                   'y' => string
 *                ];
 */