8

メソッドがPHPDocとのインターフェースの一部であることを示す方法は?

例えば：

/**
 * @implements BarInterface
 */
class Foo implements BarInterface
{
    /**
     * @thisMethodIsHereBecauseItIsAPartOf("BarInterface")
     */
    public function doBar()
    {
    }
}

交換@thisMethodIsHereBecauseItIsAPartOf("BarInterface")するのに適したものはありますか？

4

1 に答える 1

13

メソッドがPHPDocとのインターフェースの一部であることを示す方法は?

implements BarInterface通常、これらはソース コード ドキュメント システムによって自動的に処理されるため、ドキュメント化する必要はありません。

ただし、次のものも使用できます@inherit(doc)。

/**
 * @implements BarInterface
 */
class Foo implements BarInterface
{
    /**
     * @inherit
     * {@inherit}
     * {@inheritdoc}
     */
    public function doBar()
    {
    }
}

あなたの@implements BarInterface上については、クラス定義にすでに書かれているので、これは不要です。コメントはコードとしてカウントされ、余分なコードを書くべきではないため、削除することをお勧めします。

于 2013-04-10T11:56:39.420 に答える