【问题标题】:When writing a comment header for documentation, how do I specify that this function returns another function?在为文档编写注释头时,如何指定该函数返回另一个函数?
【发布时间】:2017-06-03 23:50:48
【问题描述】:

举个例子:

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

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

         return $this->bar();

     }

     return 'foobar';         
 }

在哪里????也就是说,如果条件只产生一个字符串,我可以写@return string,但是如何记录bar() 方法的返回结果呢?

【问题讨论】:

    标签: php documentation styles comments


    【解决方案1】:

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

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

    @return string

    1. 不确定$this->bar() 的类型是什么,在这种情况下使用:

    @return mixed

    【讨论】:

      猜你喜欢
      • 2012-12-25
      • 2020-01-12
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2021-12-18
      • 2014-01-08
      相关资源
      最近更新 更多