正确注释类方法的返回值

Question

对于类方法，正确的PHPDocumentor注释是什么？如果失败，该方法将返回一个布尔值，否则将返回一个类似于数组的值。这是我的代码示例：

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

    if($q->execute())
    {
        return $q;
    } else {
        return false;
    }
}

Answer 1

看看phpDocumentor manual。

示例：

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