php - phpdoc 如何记录@return 成功和失败

Question

我正在尝试正确保存我的 php rest 服务器文档，所以我想知道我们如何记录返回值可以是 2 之一？

  /**
   * send email to a user that contain reset data
   * it also create reset token, so if there was an old reset token it will be changed
   *
   * @param email $email {@type email"
   * @return SuccessMessage|FailMessage
   */
  public function getSearch($email){
   // search for $email, if success return 
   if($this->doOperation()===true){
     return new SuccessMessage($email);
   }

   return new FailMessage($email);
  }

现在 FailMessage 和 SuccessMessage 都只是空类来充当一致的数据结构

更像这样的东西。

class FailMessage extends Messages{
  function __construct(string $message, int $uid) {
      if(is_callable("parent::__construct")){
        parent::__construct(...func_get_args());
      }
      $this->uid = $uid;
      $this->message = $data;
   }
}

Answer 1

  /**
   * send email to a user that contain reset data
   * it also create reset token, so if there was an old reset token it will be changed
   *
   * @param email $email {@type email"
   * @return object SuccessMessage|FailMessage
   */

您自己的评论是好的，但更多您可以添加对象类型。另请阅读官方网站上的以下文档：

returnTags-PHPDoc