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

前端之家收集整理的这篇文章主要介绍了如何表明该方法是PHPDoc接口的一部分?前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
如何表明该方法PHPDoc接口的一部分?

例如:

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

是否有适当的替换@thisMethodIsHereBecauseItIsAPartOf(“BarInterface”)?

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

您不需要记录它,因为您使用实现BarInterface和源代码文档系统通常会自动处理这些.

但是你也可以使用@inherit(doc):

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

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

原文链接:https://www.f2er.com/php/130258.html

猜你在找的PHP相关文章