我应该使用@return self、this 还是当前类？ [关闭]

Question

我有一个返回当前对象的方法，我该如何记录呢？

/**
 * set something
 *
 * @return this
 */
public function setSomething(){
            // ...
    return $this;
}

或者我应该使用@return self 还是@return Current_Class_Name？

---

为什么这个问题不是“主要基于意见”（并且应该重新打开）的原因：符合标准和 IDE 类型提示支持。

Answer 1

草稿中有一个PHP Standards Recommendation (PSR) (PSR-5) that proposes @return $this 用于指示返回相同的实例。

$this，此类型适用的元素与给定上下文中的当前类完全相同。因此，这种类型是 static 的更严格版本，此外，返回的实例不仅必须属于同一类，而且必须属于同一实例。

此类型通常用作实现 Fluent Interface 设计模式的方法的返回值。

目前流行的 IDE（例如 PhpStorm 和 Netbeans）使用这种表示法。

Answer 2

这个问题比较老了，不过就是想分享给大家！

至少对于那些使用 NetBeans 8.1..这种表示法使得 代码自动完成功能在 IDE 中可以很好地工作：

/**
 * Method that returns $this instance (using late state binding)
 * @return static
 */
 public function iWillReturnMyself ( ) {
     return $this;
 }

我说至少适用于 NetBeans8.1 用户，但也可以在旧版本和/或其他 IDE 上工作 =]

Answer 3

/**
 * set something
 *
 * @return self
 */
public function setSomething(){
            // ...
    return $this;
}

您可以使用“self”类型作为@param 或@return..

PHPDoc 建议使用 'self' 来引用对象中的 self..

来源：http://www.phpdoc.org/docs/latest/references/phpdoc/types.html

Answer 4

@return Current_Class_Name 肯定会起作用，而且是我更喜欢的。

@return self 也可能适用于某些程序。

@return this 不好，因为这不是类型名。