phpdoc用于继承方法

Question

我有一个类A和一些返回bool值的方法.我为该方法制作了phpdoc.

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

我想为新方法制作phpdoc.我可以使用{@inheritDoc},但它需要旧方法的完整phpdoc.我想从旧的phpdoc一般方法描述和参数规范,但更改返回值的描述.

我怎么能这样做？

Answer 1

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

方法函数的继承类似于类和接口.当当前类的超类包含具有相同名称的方法时(因此,重新定义此方法),则从该重写方法继承以下信息:

• 摘要
• 描述
• 以下标签:
  • 作者
  • 版权
  • 版
  • PARAM
  • 返回
  • 投

与类一样,如果重新定义的方法的DocBlock没有要继承的元素,则上述每个都将被继承.因此,例如,如果重新定义的方法的DocBlock具有摘要,则它将不会接收重写方法的摘要.

但是根据经验,IDE会以自己的方式处理这些数据,因此结果可能会有所不同.例如,在IntelliJ/PHPStorm中,父方法docs将被继承,但您可以覆盖所有内容或不覆盖任何内容.