【问题标题】:PHPdoc: Documenting chainable methods?PHPdoc:记录可链接的方法?
【发布时间】:2011-11-03 12:08:26
【问题描述】:

我应该如何正确使用 PHPdoc 来记录类中的可链接方法,如下例所示 - 正确的用法是什么?

class myClass {


    /**
    * @return myClass
    */
    function one()
    {
        return $this;
    }

    /**
    * @return self
    */
    function two()
    {
        return $this;
    }

    /**
    * @return $this
    */
    function three()
    {
        return $this;
    }

}

【问题讨论】:

    标签: php oop documentation phpdoc


    【解决方案1】:
    /**
    * @return myClass
    */
    

    我不是 phpDoc 专家,但他们在 Zend 框架中就是这样做的。所以我认为它是可靠的

    【讨论】:

    • 这个选项往往效果最好,尤其是 IDE 自动完成。
    【解决方案2】:

    我更喜欢

    /**
    * @return $this
    */
    

    【讨论】:

    • PHPDoc 支持吗?在我看来,这只是运行时,而不是静态代码文档。
    猜你喜欢
    • 2014-01-13
    • 2015-07-16
    • 2011-06-27
    • 2013-03-03
    • 1970-01-01
    • 2017-09-28
    • 2011-04-05
    • 2013-01-08
    • 1970-01-01
    相关资源
    最近更新 更多