在PHP上使用DocBlocks,当我不使用Execution处理错误时,是否应该使用@throws?
我有一个处理错误的类,它没有使用在PHP上使用DocBlocks,当我不使用Execution处理错误时,是否应该使用@throws?,php,comments,docblocks,Php,Comments,Docblocks,我有一个处理错误的类,它没有使用try-throw-catch机制 当我评论使用该类的代码时,我是否应该使用@throws标记,即使我实际上没有抛出任何东西 编辑(尽量让我的问题更清楚): 我的问题是,如果@throw标记意味着在使用代码时可能发生错误,而我正在以某种方式处理它,或者它意味着可能发生错误,而我正在专门使用throw关键字来处理它?阅读后,我意识到这并没有被准确地解释出来 关于@throws的文档建议,如果throw关键字在代码块中存在,那么应该为可能引发的每种类型的异常进行文档记
try-throw-catch
机制
当我评论使用该类的代码时,我是否应该使用@throws
标记,即使我实际上没有抛出任何东西
编辑(尽量让我的问题更清楚):
我的问题是,如果@throw
标记意味着在使用代码时可能发生错误,而我正在以某种方式处理它,或者它意味着可能发生错误,而我正在专门使用throw
关键字来处理它?阅读后,我意识到这并没有被准确地解释出来
关于@throws
的文档建议,如果throw
关键字在代码块中存在,那么应该为可能引发的每种类型的异常进行文档记录,而不管您是否在处理它
所以如果你有
try {
throw new Exception();
} catch (Exception $e) {
// handled!
}
在docblock中放置一个@throws
条目。阅读后,我意识到这并没有完全解释清楚
关于@throws
的文档建议,如果throw
关键字在代码块中存在,那么应该为可能引发的每种类型的异常进行文档记录,而不管您是否在处理它
所以如果你有
try {
throw new Exception();
} catch (Exception $e) {
// handled!
}
在docblock中放置一个@throws
条目。阅读后,我意识到这并没有完全解释清楚
关于@throws
的文档建议,如果throw
关键字在代码块中存在,那么应该为可能引发的每种类型的异常进行文档记录,而不管您是否在处理它
所以如果你有
try {
throw new Exception();
} catch (Exception $e) {
// handled!
}
在docblock中放置一个@throws
条目。阅读后,我意识到这并没有完全解释清楚
关于@throws
的文档建议,如果throw
关键字在代码块中存在,那么应该为可能引发的每种类型的异常进行文档记录,而不管您是否在处理它
所以如果你有
try {
throw new Exception();
} catch (Exception $e) {
// handled!
}
将
@throws
条目放入docblock。放置注释@throws将此方法标记为不安全。调用此方法时,客户端应准备好处理此异常。Puting annotation@throws将此方法标记为不安全。调用此方法时,客户端应准备好处理此异常。Puting annotation@throws将此方法标记为不安全。调用此方法时,客户端应准备好处理此异常。Puting annotation@throws将此方法标记为不安全。当调用此方法时,客户机应准备好处理此异常。注释用于提高清晰度。如果不可能扔东西,就不要放@throw。为什么不把它写在答案中呢?:)因为你的问题不清楚。想清楚点。@Ali,搞定了!谢谢你现在能帮我吗?评论是为了提高清晰度。如果不可能扔东西,就不要放@throw。为什么不把它写在答案中呢?:)因为你的问题不清楚。想清楚点。@Ali,搞定了!谢谢你现在能帮我吗?评论是为了提高清晰度。如果不可能扔东西,就不要放@throw。为什么不把它写在答案中呢?:)因为你的问题不清楚。想清楚点。@Ali,搞定了!谢谢你现在能帮我吗?评论是为了提高清晰度。如果不可能扔东西,就不要放@throw。为什么不把它写在答案中呢?:)因为你的问题不清楚。想清楚点。@Ali,搞定了!谢谢你现在能帮我吗?