微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

如何表明该方法是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.jb51.cc/php/130258.html

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐