Question

例如，请考虑以下代码：

/**
 * @param array $array
 * @param string $key
 * @return mixed
 * @throws \InvalidArgumentException
 */
private function getArrayEntry(& $array, $key)
{
    if (!array_key_exists($key, $array)) {
        throw new \InvalidArgumentException(
            'Invalid array of values for location. Missing '.$key.'.'
        );
    }

    return $array[$key];
}

/**
 * @param array $data
 * @return Location
 */
public function createFromArray(array $data)
{
    $this->getArrayEntry($data, 'name');
}

第二种方法是否也应该在doc bloc中使用@throws？

与具有'throws'关键字的Java相比，如何使用它？

Answer 1

@throws应该只放在抛出异常的方法的docBlock中。如果你把它放在堆栈上它将是多余的，并且违反了DRY原则！

在java中，您可以选择@throws和@exception ..see here

顺便说一下：你正在抛出错误的异常类型。你应该抛出一个\OutOfBoundsException。否则违反了POLA。 \InvalidArgumentException用于意外的参数类型。

我应该使用抛出异常的函数将PHPDoc中的@throws添加到函数中吗？

1 个答案: