在为文档写评论 header 时,如何指定此功能 returns 另一个功能?
When writing a comment header for documentation, how do I specify that this function returns another function?
举个例子:
/**
* foo function
* @param Fooby $fooby
* @return ????
**/
public function foo(Fooby $fooby) {
if ($fooby == self::BAR) {
return $this->bar();
}
return 'foobar';
}
在哪里????是,如果条件只产生一个字符串,我可以写 @return string
,但是如何记录 bar()
方法结果的 return?
在这种情况下,您需要检查 $this->bar()
的可能性有哪些,可能有两种情况:
- 确定
$this->bar()
将始终是一个字符串,在这种情况下使用:
@return string
- 不确定
$this->bar()
的类型是什么,在这种情况下使用:
@return mixed
举个例子:
/**
* foo function
* @param Fooby $fooby
* @return ????
**/
public function foo(Fooby $fooby) {
if ($fooby == self::BAR) {
return $this->bar();
}
return 'foobar';
}
在哪里????是,如果条件只产生一个字符串,我可以写 @return string
,但是如何记录 bar()
方法结果的 return?
在这种情况下,您需要检查 $this->bar()
的可能性有哪些,可能有两种情况:
- 确定
$this->bar()
将始终是一个字符串,在这种情况下使用:
@return string
- 不确定
$this->bar()
的类型是什么,在这种情况下使用:
@return mixed