我如何通知用户一个带有文档注释的魔法方法可以抛出异常？答案

【问题标题】：How do I inform users a doccommented magic method can throw an Exception?我如何通知用户一个带有文档注释的魔法方法可以抛出异常？
【发布时间】：2021-09-27 03:17:21
【问题描述】：

我对这样的课程有一个文档评论：

/**
 * @method Response\FooResponse foo(Parameters\FooParameters $parameters)
 */
class Foo
{
}

这个方法可以抛出一个FooException。我如何在文档注释中指出这一点？

【问题讨论】：

接近投票者的注意事项 - 这还没有答案 - 链接的答案涉及一流的方法而不是方法注释。
文档On the phpDocs website
@RiggsFolly 我不相信这显示了如何将它用于方法注释，仅用于“真实”方法
好的，为你重新打开，不是我的 DV
@RiggsFolly 谢谢！

标签： php

【解决方案1】：

只需在文档块中使用 PHPDoc 的@throws 来指定该方法中可能发生的异常类型。

【讨论】：

如果您显示编码到他的文档块中的 OP，这将是一个更好的答案
我知道它存在，但我不知道如何将它专门带入 @method 注释中。我在任何地方都找不到记录。

【解决方案2】：

由于 JSDocs 的定义相似，您可以使用@throws。检查这篇文章以供参考： https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#throwstag

【讨论】：