CODEWITHSUNDEEP
phpphpdoc
Mateusz Charytoniuk
Mateusz Charytoniuk

Reputation: 1897

How to indicate that method is a part of interface with PHPDoc?

How to indicate that method is a part of interface with PHPDoc?

For example:

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

Is there anything appropriate to replace @thisMethodIsHereBecauseItIsAPartOf("BarInterface") with?

Upvotes: 9

Views: 7098

Answers (1)

M8R-1jmw5r
M8R-1jmw5r

Reputation: 4996

How to indicate that method is a part of interface with PHPDoc?

You do not need to document that, because you use implements BarInterface and a source-code documentation system normally handles these automatically.

However you can also use @inherit(doc):

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

About your @implements BarInterface on top, this is superfluous, because it's already written in the class definition. As comments count as code, and as you should not write superfluous code, I suggest you to remove it.

Upvotes: 15

Related Questions