親からすべてのドキュメントを継承したい場合、phpDocumentor の @inheritDoc の正しい構文は何ですか? おそらく、複数の構文が正しいのでしょうか?
@inheritDoc{@inheritDoc}@inheritdoc{@inheritdoc}
ドキュメントはかなり曖昧だと思います。PhpStorm はそれらすべてをサポートしているようですが、構文によってはドキュメントの生成に問題があるのではないでしょうか?
22469 次
2 に答える
56
子要素は、このタグを必要とせずに、親 docblock からほとんどすべてを自動的に継承する必要があります。そうしないと、元のインターフェイスのドキュメントから何も得られずに、すべての実装メソッドをもう一度ドキュメント化する必要があります。
簡単に言えば、docblock を持たない継承要素は、親の docblock からすべてを自動的に継承する必要があります。
このタグの唯一の目的は、親 docblock から1 つの@inheritdocもの (親の詳細説明) をインポートできるようにすることです。子がまだこれを利用可能にすべきではない唯一の理由は、子が先に進んで独自の docblock を持っていた場合です。これで、子は、親の長い説明 を除いて、複製することなく、親の docblock からほぼすべてを継承する必要があります。何らかの理由で子 docblock が独自の docblock を持つことを選択し、それでも親の長い説明を継承したい場合は、どこに置くか@inheritdoc子 docblock で、その親の長い説明が表示される場所を決定します。したがって、子は独自の短い説明と長い説明を持つことができ、子の長い説明に関連する指定された場所に親の長い説明を含めること もできます。これが、このタグが生まれた唯一の理由です:-)
IDE オートコンプリートに関しては、このタグに関しては、IDE 間で一貫した動作が見られたとは言えません。さらに、このタグが親 docblock から継承された情報が発生する理由であると仮定されているプロジェクトを見てきました。
于 2014-10-24T18:43:11.193 に答える