记录(phpdoc)生成器的最佳方式(生成的方法)

Question

对于phpdocumentor2来说，记录生成器方法的最佳方式是什么？

我不认为@return真的适用于yield，但我似乎找不到任何合适的替代方案。

这仅仅是等待phpdoc赶上的问题吗？

Answer 1

我选择了@return Generator|SomeObject[]，其中SomeObject是被放弃的东西。

PhpStorm也很好地处理了这一点，因为它现在通常会提示Generator方法，并且在迭代时会提示SomeObject方法。

(不过，我更喜欢原生@yield。)

Answer 2

From the PHP Manual

第一次调用生成器函数时，将返回内部generator类的对象。

因此，严格地说，@return Generator是正确的，尽管它不能很好地描述当您迭代生成器时可以期望得到的结果。