web-dev-qa-db-ja.com

phpDocumentorのinheritDocの正しい構文

親からすべてのドキュメントを継承したい場合、phpDocumentorの@inheritDocの正しい構文は何ですか?多分複数の構文が正しいですか?

  1. @inheritDoc
  2. {@inheritDoc}
  3. @inheritdoc
  4. {@inheritdoc}

ドキュメントはかなり曖昧だと思います。 PhpStormはそれらすべてをサポートしているようですが、いくつかの構文でドキュメントを生成するのに問題があるかもしれません。

28
Borek Bernard

子要素は、このタグを必要とせずに、親docblockからほとんどすべてを自動的に継承する必要があります。それ以外の場合は、元のインターフェイスのドキュメントで何も得ずに、すべての実装メソッドを何度もドキュメント化する必要があります。

単に、docblockなしで継承された要素shouldは、親のdocblockから自動的にeverythingを継承します。

@inheritdocタグの唯一の目的は、親docblockからoneをインポートする手助けをすることです-その親の詳細説明。子供がこれをまだ利用できないはずである唯一の理由は、子供が先に進んで独自のdocblockを持っている場合です。さて、子はそれを複製する必要なしに、親docblockからほぼすべてを継承します... except親の長い説明。 If子docblockが何らかの理由で独自のdocblockを選択した場合、andあなたstillが親の詳細説明を継承したい場合、子docblockに@inheritdocを置く場所によって、その親の詳細説明が表示される場所が決まります。したがって、子は独自の短い説明と長い説明を持つことができ、それでもalsoは、子の長い説明に関連して指定された場所に親の長い説明を含めます。 これがこのタグが生まれた唯一の理由です :-)

IDEオートコンプリートに関しては、このタグに関しては、IDE全体で一貫した動作が見られたとは言えません。さらに、これがタグ理由です親docblockから情報を継承した場合でも発生します。

43
ashnazg

IDEサポートについては何も知りませんが、 documentation{@inheritDoc}

2
Fahmi