在PHP上使用DocBlocks,当我不处理execpetion错误时,我应该使用@throws吗?

时间:2015-10-22 14:50:35

标签: php comments docblocks

我有一个处理错误的类,它没有使用try-throw-catch机制。

当我评论使用该类的代码时,即使我实际上没有扔任何东西,我应该使用@throws标记吗?

编辑(尝试让我的问题更清晰):

我的问题是,@throws标签是否意味着在使用代码时可能会发生错误,而我正在以某种方式处理它,或者这意味着可能会发生错误,我正在使用{处理它{1}}关键字具体是什么?

2 个答案:

答案 0 :(得分:2)

在阅读the documentation之后,我意识到这并没有完全明确说明。

@throws上的文档表明,如果代码块中的所有throw关键字都存在,则应记录每种类型的异常,无论是否可以抛出你是否正在处理它。

所以,如果你有

try {
    throw new Exception();
} catch (Exception $e) {
    // handled!
}

在docblock中添加@throws条目。

答案 1 :(得分:1)

使用注释@throws将此方法标记为不安全。客户端应该准备好在调用此方法时处理此异常。