Правильное комментирование возвращаемого значения метода класса

Question

Какой будет правильный комментарий PHPDocumentor для метода класса, который возвращает логическое значение в случае сбоя и что-то вроде массива, если это не так.Вот мой пример кода:

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

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

Answer 1

Просмотрите руководство phpDocumentor .

Пример:

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