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

Question

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

В качестве примера:

/**
* foo function
* @param Fooby $fooby
* @return ????
**/
public function foo(Fooby $fooby) {

if ($fooby == self::BAR) {

return $this->bar();

}

return 'foobar';
}

Где ???? есть, если условие приводит только к строке, я мог бы написать @return stringОднако, как мне документировать возврат результата bar() Метод ?.

2

comments documentation php styles

Решение

Другие решения

Других решений пока нет …

Источник

Accepted Answer

В таком состоянии нужно проверить, каковы возможности $this->bar() может быть два случая:

Уверен, что $this->bar() всегда будет строкой, в этом случае используйте:

@return string

Не уверен, что будет тип $this->bar() , в этом случае используйте:

@return mixed

2