如何表明该方法是PHPDoc接口的一部分？

Question

如何指示该方法是PHPDoc接口的一部分？

例如：

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

是否有适当的替换@thisMethodIsHereBecauseItIsAPartOf("BarInterface")？

Answer 1

  

如何指示该方法是PHPDoc接口的一部分？

您不需要记录，因为您使用implements BarInterface并且源代码文档系统通常会自动处理这些文档。

但您也可以使用@inherit(doc)：

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

关于您的@implements BarInterface，这是多余的，因为它已经写在类定义中了。由于注释计为代码，并且您不应该编写多余的代码，我建议您将其删除。