我应该把@throws放在docs中吗？

Question

如果在我的方法中调用的另一个方法中抛出此异常，我应该将@throws放在方法文档中吗？

实施例

class ClassOne{
    /**
     * @throws MyException
     *
     * @return void
     */
    public function aMethod()
    {
        if(true)
        {
            throw new MyException();
        }
    }
}

class ClassTwo{
    /**
     * @throws MyException           // should I document this line?
     *
     * @return void
     */
    public function myMethod()
    {
        $classOne = new ClassOne();

        $classOne->aMethod();
    }
}

使用PHPStorm生成DocBlock时，它没有看到ClassOne中的异常，也没有在ClassTwo文档中放置@throws行。

Answer 1

如果您没有捕获异常，那么如果您想编写干净的代码，您将使用PHP-Doc表示法。下一个使用你的类的人获得了他必须捕获异常或传递异常的IDE的消息洞察力。 运行代码并不重要。