使用DocBlocks -如何指示函数仅在某些条件下返回值？

Question

我的职能是：

public function createController()
{
    $valid_controller = class_exists($this->controllerClass)
                    &&  in_array("BaseController", class_parents($this->controllerClass));

    if($valid_controller)
    {
        return new $this->controllerClass($this->urlData["action"]);
    }
    else
    {
        $error = new ErrorController("badurl");
    }
}

我想要创建一个描述它的DocBlock。此函数仅在所需控制器有效时才返回控制器对象，如果不是，则创建ErrorController类的实例，但不返回值。我如何才能为这个函数设置一个合适的@return标记呢？

Answer 1

PHPDocumentor文档说用

@return  null|ControllerClass    text description or explanation here