PHP是否有用于描述无极功能的docblock返回

Question

我只是写这样的函数

/** 
    * Send an asynchronous GET request 
    * 
    * @param string $url 
    * @param array $options 
    * 
    * @return \React\Promise\ExtendedPromiseInterface 
    */ 
    public function getAsync($url, array $options = []); 

但做的docblock的时候，我意识到，@return \React\Promise\ExtendedPromiseInterface很普通，没有真正帮助客户了解什么约定在拒绝或履行的情况下，预计会有退货。

是否有一些建立的约定用于记录作为此函数结果的预期值或异常，以便客户端可以通过仅查看接口链接此函数？

Answer 1

由于没有发现任何东西，我最终使这件事

/** 
    * Send an asynchronous GET request 
    * 
    * @param string $url 
    * @param array $options 
    * 
    * @return \React\Promise\ExtendedPromiseInterface 
    * 
    * @promise.resolve \MyApp\Interfaces\ResponseInterface 
    * @promise.reject \MyApp\Exceptions\RequestException 
    */ 
    public function getAsync($url, array $options = []); 

Answer 2

例外情况您可以添加：

/** 
* @throws customException if the bad thing happens 
*/ 

你可以添加尽可能多的这些，你喜欢了。在@return之后，您可以在之前添加一个类型，并简要描述它之后的内容。