在 PHP 上使用 DocBlocks,当我不使用 execpetion 处理错误时,我应该使用 @throws 吗?
Using DocBlocks on PHP, Should I use @throws when I do not handle errors with execpetion?
我有一个 class 用于处理错误,它没有使用 try-throw-catch
机制。
当我评论使用 class 的代码时,我是否应该使用 @throws
标签,即使我实际上并没有抛出任何东西?
编辑(尽量让我的问题更清楚):
我的问题是 @throws
标签是否意味着在使用代码时可能会发生错误并且我正在以某种方式处理它,或者这意味着可能会发生错误并且我正在通过使用来处理它具体 throw
关键字?
看完the documentation,我发现这里写的并不准确
@throws
上的文档建议,如果 throw
关键字完全存在于代码块中,则应该记录每种可能抛出的异常类型,无论是否不管你是否在处理它。
所以如果你有
try {
throw new Exception();
} catch (Exception $e) {
// handled!
}
在文档块中添加一个 @throws
条目。
放置注释@throws 将此方法标记为不安全。调用此方法时,客户端应准备好处理此异常。
我有一个 class 用于处理错误,它没有使用 try-throw-catch
机制。
当我评论使用 class 的代码时,我是否应该使用 @throws
标签,即使我实际上并没有抛出任何东西?
编辑(尽量让我的问题更清楚):
我的问题是 @throws
标签是否意味着在使用代码时可能会发生错误并且我正在以某种方式处理它,或者这意味着可能会发生错误并且我正在通过使用来处理它具体 throw
关键字?
看完the documentation,我发现这里写的并不准确
@throws
上的文档建议,如果 throw
关键字完全存在于代码块中,则应该记录每种可能抛出的异常类型,无论是否不管你是否在处理它。
所以如果你有
try {
throw new Exception();
} catch (Exception $e) {
// handled!
}
在文档块中添加一个 @throws
条目。
放置注释@throws 将此方法标记为不安全。调用此方法时,客户端应准备好处理此异常。