php - 在为文档编写注释头时,如何指定该函数返回另一个函数?

标签 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() 方法结果的返回?

最佳答案

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

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

@return 字符串

  • 不确定 $this->bar() 的类型是什么,在这种情况下使用:
  • @return 混合

    关于php - 在为文档编写注释头时,如何指定该函数返回另一个函数?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/41739106/

    相关文章:

    c++ - 是否存在用于编辑 doxygen 评论的 "wiki"?

    kotlin - 使用 KDoc 记录 Ktor 路由

    javascript - 多个 CSS 样式

    c - for 无增量 vs while

    php - 从数据库中获取同一列的两行不同值(MySQL)

    PHP select - 浏览器和二维码阅读器的不同值

    php - 无法在 android 中使用 php 从本地主机获取数据

    php - mysql数据没有根据html表中的id出现

    R和roxygen2 : How to document data files in inst/extdata?

    Android 系统颜色常数