在为文档编写注释标题时,如何指定此函数返回另一个函数?

时间:2017-01-19 10:11:48

标签: php documentation styles comments

举个例子:

/**
 * foo function
 * @param Fooby $fooby
 * @return ????
 **/
 public function foo(Fooby $fooby) {

     if ($fooby == self::BAR) {

         return $this->bar();

     }

     return 'foobar';         
 }

哪里????是,如果条件只导致一个字符串,我可以写@return string,但是如何记录bar()方法结果的返回?。

1 个答案:

答案 0 :(得分:2)

在这种情况下,您需要检查$this->bar()的可能性,可能有两种情况:

  1. 确定$this->bar()始终是一个字符串,在这种情况下使用:
  2. @return string

    1. 它不确定会是$this->bar()的类型,在这种情况下使用:
    2. @return mixed