Php 类方法返回值的正确注释

Php 类方法返回值的正确注释,php,phpdoc,Php,Phpdoc,对于一个类方法,如果失败则返回布尔值,如果失败则返回类似数组的值,那么正确的PHPDocumentor注释是什么。下面是我的代码示例: public function getServers() { $q = $this->db->query('SELECT * FROM servers'); if($q->execute()) { return $q; } else { return false; } }

对于一个类方法,如果失败则返回布尔值,如果失败则返回类似数组的值,那么正确的PHPDocumentor注释是什么。下面是我的代码示例:

public function getServers()
{
    $q = $this->db->query('SELECT * FROM servers');

    if($q->execute())
    {
        return $q;
    } else {
        return false;
    }
}
看看这本书

例如:

/**
 * @return array|bool some result or false if none found.
 */
public function getServers()
{   
[...]

您不应该
return false
而应该
try
ing和
catch
ing这些错误并将其记录在错误日志中