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

我有这样的功能：使用DocBlocks - 如何指示函数仅在某些情况下返回值？

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"); 
    } 
}

，我想创建一个描述它一个文档块。该函数仅在所需控制器有效时才返回控制器对象，否则将创建类的示例，但不返回值。我怎样才能为这个功能正确的@return标签？

来源

2015-11-02 Sipo

'@返回空| ControllerClass文字说明或解释here' –

为什么不'空| object'？并且请把你的答案放在......好，一个答案，所以我可以接受它。 :) – Sipo

由于'object'没有任何具体的含义....你应该使用一个实际的接口或对象名称，然后可以由IDE接收 –

PHPDocumentor Docs说使用

@return null|ControllerClass text description or explanation here

来源

2015-11-02 11:55:41

但是'ControllerClass'是一个属性，而不是不变。那么我怎么能专门提到它，因为它每次都会改变？ – Sipo

返回什么对象类型？所有控制器之间必须有一些继承或接口的通用性。 'BaseController'也许？ –

'BaseController'是我所有控制器的父代... – Sipo

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

回答

相关问题