php - 对于抽象函数，phpdoc 应该为抽象函数、实现函数还是两者定义？

Question

是否有正确或标准的方法来执行此操作？

例如:

AbstractFoo.php:

abstract class AbstractFoo {
    /**
     * Does the phpdoc go here?
     */
    public function fooFunction();
}

Foo.php:

class Foo extends AbstractFoo {
    /**
     * Or does the phpdoc go here?
     */
    public function fooFunction(){
        // some implementation
    }
}

考虑以下问题:

• 如果您将 phpdoc 放在抽象的 FooFunction() 中，然后控制并单击 $foo->FooFunction()，您将最终到达 Foo class' FooFunction()，它没有记录，并且不是很明显它正在实现一个抽象函数。如果很明显，没有

  就没有简单的方法来访问抽象函数中的 phpdoc
  • 确定对象属于什么类别
  • 找到它继承的抽象类
  • 对该抽象类中的函数名称进行“查找”

• 如果您只将 phpdoc 放在子函数中，那么您将面临在 n 个继承类的子函数中复制 phpdoc。

• 如果你把 phpdoc 放在两者中，抽象函数的 phpdoc 就变得毫无意义，除非子类没有 phpdoc，想要继承抽象的 phpdoc。但即使在这种情况下，也没有简单的方法导航到那个抽象的 phpdoc。

Answer 1

您应该记录接口(interface)或抽象实现。否则，使用@inheritdoc/document 接口(interface)方法的实现。