web-dev-qa-db-ja.com

(phpdoc)ジェネレーター(生成されるメソッド)を文書化する最良の方法

Phpdocumentor2の場合、ジェネレーターであるメソッドを文書化する最良の方法は何ですか。

私は思いません@returnは本当にyieldで機能しますが、適切な代替手段を見つけることができません。

Phpdocが追いつくのを待つだけの問題ですか?

31
Mat-Locomotive

私は@return Generator|SomeObject[]、ここでSomeObjectは生成されるものです。

PhpStormもこれを適切に処理します。これは、通常はGeneratorメソッドのヒントを示し、反復するとSomeObjectメソッドのヒントを示すためです。

(それでも、ネイティブ@yield。)

28
Robbert

PHP Manual から:

ジェネレータ関数が初めて呼び出されると、内部ジェネレータクラスのオブジェクトが返されます。

厳密に言えば、@return Generatorは正しいでしょうが、ジェネレーターを反復処理したときに何が返されるかを説明するものではありません。

8