Документация: как мне документировать, что функция может возвращать более одного типа переменных?

Question

Документация: как мне документировать, что функция может возвращать более одного типа переменных?

Предположим, что PHP-функция выглядит так:

/**
* Description
*
* @return  Namespace\GenericObject
*/
function doSomething() {
if ($some_parameter) {
return new GenericObject;
} else {
return FALSE;
}
}

Как следует return функции документируются, используя стандарт PHPDoc? Насколько я знаю, функция должна иметь только один return документированная, тем не менее, вышеприведенная функция может возвращать либо новый объект, либо bool.

1

documentation php phpdoc

Решение

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

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

Источник

Accepted Answer

Используйте или | оператор.

/**
* Description
*
* @return  Namespace\GenericObject|null|array|false
*/
function doSomething() {
if ($some_parameter) {
return new GenericObject;
} else {
return FALSE;
}
}

4