Phpdoc用于继承方法


phpdoc for inherited method

我有类A和一些返回bool值的方法。我为这个方法创建了phpdoc

我创建了另一个类B,它扩展了类A并覆盖了方法。新方法返回字符串。(我知道在一般情况下改变返回类型不是一个好主意,但在我的情况下,这是一个好方法。)

我想让phpdoc for new method。我可以使用{@inheritDoc},但它需要旧方法的完整phpdoc。我想从旧的phpdoc通用方法描述和参数规范,但改变返回值的描述。

我怎么能做到呢?

基于phpDocumentor手册的继承方法将继承而不需要内联的{@inheritDoc}标记,您可以根据需要重写标记。

方法函数的继承类似于类和接口。当前类的超类包含具有相同方法的方法名称(因此,此方法被重新定义),然后是以下信息继承自被重写的方法:

  • 以下标签:
      作者
    • 参数

与类一样,只有在重定义方法的DocBlock中没有要创建的元素继承。例如,如果重定义方法的DocBlock有一个摘要,那么它将不会收到重写的方法的总结。

但是根据经验,IDE的句柄以自己的方式解析这些数据,因此结果可能会有所不同。例如,在IntelliJ/PHPStorm中,父方法docs将被继承,但你可以重写所有内容,也可以不重写。