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

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 来描述它。此函数 return 仅当所需的控制器有效时才是控制器对象，否则，它会创建 ErrorController class 的实例，但不会 return 值。我怎样才能为这个功能正确的 @return 标签？

Answer 1

PHPDocumentor Docs说用

@return  null|ControllerClass    text description or explanation here

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

Using DocBlocks - how to indicate that a function returns a value only in some conditions?

php

model-view-controller

docblocks